organizations

Organization related operations

List or search all organizations

GET//www.data.gouv.fr/api/1/organizations/

Query parameters

Header parameters

Response

Success

Body

dataarray of Organization (object)

The page data

next_pagestring

The next page URL if exists

page*integer

The current page

page_size*integer

The page size used for pagination

previous_pagestring

The previous page URL if exists

total*integer

The total paginated items

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "business_number_id": "text",
      "created_at": "2024-05-09T04:25:36.224Z",
      "deleted": "2024-05-09T04:25:36.224Z",
      "description": "text",
      "id": "text",
      "last_modified": "2024-05-09T04:25:36.224Z",
      "logo": "text",
      "logo_thumbnail": "text",
      "members": [
        {
          "role": "admin",
          "user": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        }
      ],
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text",
      "url": "text"
    }
  ],
  "next_page": "text",
  "previous_page": "text"
}

Create a new organization

POST//www.data.gouv.fr/api/1/organizations/

Header parameters

Body

acronymstring

The organization acronym

badgesarray of Badge (object)

The organization badges

business_number_idstring

The organization's business identification number.

created_atstring (date-time)

The organization creation date

deletedstring (date-time)

The organization deletion date if deleted

description*string (markdown)

The organization description in Markdown

extrasobject

Extras attributes as key-value pairs

id*string

The organization identifier

last_modifiedstring (date-time)

The organization last modification date

logostring

The organization logo URL

logo_thumbnailstring

The organization logo thumbnail URL. This is the square (100x100) and cropped version.

membersarray of all of

metricsobject

The organization metrics

name*string

The organization name

pagestring

The organization page URL

slug*string

The organization string used as permalink

uristring

The organization API URI

urlstring

The organization website URL

Response

Success

Body

acronymstring

The organization acronym

badgesarray of Badge (object)

The organization badges

business_number_idstring

The organization's business identification number.

created_atstring (date-time)

The organization creation date

deletedstring (date-time)

The organization deletion date if deleted

description*string (markdown)

The organization description in Markdown

extrasobject

Extras attributes as key-value pairs

id*string

The organization identifier

last_modifiedstring (date-time)

The organization last modification date

logostring

The organization logo URL

logo_thumbnailstring

The organization logo thumbnail URL. This is the square (100x100) and cropped version.

membersarray of all of

metricsobject

The organization metrics

name*string

The organization name

pagestring

The organization page URL

slug*string

The organization string used as permalink

uristring

The organization API URI

urlstring

The organization website URL

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "text",
      "id": "text",
      "name": "text",
      "slug": "text"
    }),
});
const data = await response.json();

Response

{
  "acronym": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "business_number_id": "text",
  "created_at": "2024-05-09T04:25:36.224Z",
  "deleted": "2024-05-09T04:25:36.224Z",
  "description": "text",
  "id": "text",
  "last_modified": "2024-05-09T04:25:36.224Z",
  "logo": "text",
  "logo_thumbnail": "text",
  "members": [
    {
      "role": "admin",
      "user": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ],
  "name": "text",
  "page": "text",
  "slug": "text",
  "uri": "text",
  "url": "text"
}

List all available organization badges and their labels

GET//www.data.gouv.fr/api/1/organizations/badges/

Response

Success

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/badges/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

List all possible organization roles

GET//www.data.gouv.fr/api/1/organizations/roles/

Header parameters

Response

Success

Body

idstring

The role identifier

labelstring

The role label

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/roles/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "label": "text"
  }
]

Organizations suggest endpoint using mongoDB contains

GET//www.data.gouv.fr/api/1/organizations/suggest/

Query parameters

Header parameters

Response

Success

Body

acronymstring

The organization acronym

idstring

The organization identifier

image_urlstring

The organization logo URL

namestring

The organization name

pagestring

The organization web page URL

slugstring

The organization permalink string

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/suggest/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "acronym": "text",
    "id": "text",
    "image_url": "text",
    "name": "text",
    "page": "text",
    "slug": "text"
  }
]

List all followers for a given object

GET//www.data.gouv.fr/api/1/organizations/{id}/followers/

Path parameters

id*string

Query parameters

Header parameters

Response

Success

Body

dataarray of Follow (object)

The page data

next_pagestring

The next page URL if exists

page*integer

The current page

page_size*integer

The page size used for pagination

previous_pagestring

The previous page URL if exists

total*integer

The total paginated items

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{id}/followers/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "follower": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "id": "text",
      "since": "2024-05-09T04:25:36.224Z"
    }
  ],
  "next_page": "text",
  "previous_page": "text"
}

Follow an object given its ID

Returns the number of followers left after the operation

POST//www.data.gouv.fr/api/1/organizations/{id}/followers/

Path parameters

id*string

Response

Success

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{id}/followers/', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Unfollow an object given its ID

Returns the number of followers left after the operation

DELETE//www.data.gouv.fr/api/1/organizations/{id}/followers/

Path parameters

id*string

Response

Success

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{id}/followers/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get a organization given its identifier

GET//www.data.gouv.fr/api/1/organizations/{org}/

Path parameters

org*string

The organization ID or slug

Header parameters

Response

Success

Body

acronymstring

The organization acronym

badgesarray of Badge (object)

The organization badges

business_number_idstring

The organization's business identification number.

created_atstring (date-time)

The organization creation date

deletedstring (date-time)

The organization deletion date if deleted

description*string (markdown)

The organization description in Markdown

extrasobject

Extras attributes as key-value pairs

id*string

The organization identifier

last_modifiedstring (date-time)

The organization last modification date

logostring

The organization logo URL

logo_thumbnailstring

The organization logo thumbnail URL. This is the square (100x100) and cropped version.

membersarray of all of

metricsobject

The organization metrics

name*string

The organization name

pagestring

The organization page URL

slug*string

The organization string used as permalink

uristring

The organization API URI

urlstring

The organization website URL

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "acronym": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "business_number_id": "text",
  "created_at": "2024-05-09T04:25:36.224Z",
  "deleted": "2024-05-09T04:25:36.224Z",
  "description": "text",
  "id": "text",
  "last_modified": "2024-05-09T04:25:36.224Z",
  "logo": "text",
  "logo_thumbnail": "text",
  "members": [
    {
      "role": "admin",
      "user": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ],
  "name": "text",
  "page": "text",
  "slug": "text",
  "uri": "text",
  "url": "text"
}

Update a organization given its identifier

PUT//www.data.gouv.fr/api/1/organizations/{org}/

Path parameters

org*string

The organization ID or slug

Header parameters

Body

acronymstring

The organization acronym

badgesarray of Badge (object)

The organization badges

business_number_idstring

The organization's business identification number.

created_atstring (date-time)

The organization creation date

deletedstring (date-time)

The organization deletion date if deleted

description*string (markdown)

The organization description in Markdown

extrasobject

Extras attributes as key-value pairs

id*string

The organization identifier

last_modifiedstring (date-time)

The organization last modification date

logostring

The organization logo URL

logo_thumbnailstring

The organization logo thumbnail URL. This is the square (100x100) and cropped version.

membersarray of all of

metricsobject

The organization metrics

name*string

The organization name

pagestring

The organization page URL

slug*string

The organization string used as permalink

uristring

The organization API URI

urlstring

The organization website URL

Response

Success

Body

acronymstring

The organization acronym

badgesarray of Badge (object)

The organization badges

business_number_idstring

The organization's business identification number.

created_atstring (date-time)

The organization creation date

deletedstring (date-time)

The organization deletion date if deleted

description*string (markdown)

The organization description in Markdown

extrasobject

Extras attributes as key-value pairs

id*string

The organization identifier

last_modifiedstring (date-time)

The organization last modification date

logostring

The organization logo URL

logo_thumbnailstring

The organization logo thumbnail URL. This is the square (100x100) and cropped version.

membersarray of all of

metricsobject

The organization metrics

name*string

The organization name

pagestring

The organization page URL

slug*string

The organization string used as permalink

uristring

The organization API URI

urlstring

The organization website URL

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "text",
      "id": "text",
      "name": "text",
      "slug": "text"
    }),
});
const data = await response.json();

Response

{
  "acronym": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "business_number_id": "text",
  "created_at": "2024-05-09T04:25:36.224Z",
  "deleted": "2024-05-09T04:25:36.224Z",
  "description": "text",
  "id": "text",
  "last_modified": "2024-05-09T04:25:36.224Z",
  "logo": "text",
  "logo_thumbnail": "text",
  "members": [
    {
      "role": "admin",
      "user": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ],
  "name": "text",
  "page": "text",
  "slug": "text",
  "uri": "text",
  "url": "text"
}

Delete a organization given its identifier

DELETE//www.data.gouv.fr/api/1/organizations/{org}/

Path parameters

org*string

The organization ID or slug

Response

Organization deleted

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Create a new badge for a given organization

POST//www.data.gouv.fr/api/1/organizations/{org}/badges/

Path parameters

org*string

The organization ID or slug

Header parameters

Body

kind*string

Kind of badge (certified, etc), specific to each model

Response

Success

Body

kind*string

Kind of badge (certified, etc), specific to each model

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/badges/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "kind": "text"
    }),
});
const data = await response.json();

Response

{
  "kind": "text"
}

Delete a badge for a given organization

DELETE//www.data.gouv.fr/api/1/organizations/{org}/badges/{badge_kind}/

Path parameters

badge_kind*string

org*string

The organization ID or slug

Response

Success

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/badges/{badge_kind}/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

GET//www.data.gouv.fr/api/1/organizations/{org}/catalog

Path parameters

org*string

The organization ID or slug

Response

Organization not found

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/catalog', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET//www.data.gouv.fr/api/1/organizations/{org}/catalog.{format}

Path parameters

org*string

The organization ID or slug

format*string

Response

Organization not found

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/catalog.{format}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

List organization datasets (including private ones when member)

GET//www.data.gouv.fr/api/1/organizations/{org}/datasets/

Path parameters

org*string

Query parameters

Header parameters

Response

Success

Body

dataarray of Dataset (object)

The page data

next_pagestring

The next page URL if exists

page*integer

The current page

page_size*integer

The page size used for pagination

previous_pagestring

The previous page URL if exists

total*integer

The total paginated items

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/datasets/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "acronym": "text",
      "archived": "2024-05-09T04:25:36.224Z",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "community_resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-05-09T04:25:36.224Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-05-09T04:25:36.224Z",
            "modified_at": "2024-05-09T04:25:36.224Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-05-09T04:25:36.224Z",
            "last_modified_internal": "2024-05-09T04:25:36.224Z"
          },
          "last_modified": "2024-05-09T04:25:36.224Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text",
          "dataset": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "page": "text",
            "title": "text",
            "uri": "text"
          },
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "badges": [
              {
                "kind": "text"
              }
            ],
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        }
      ],
      "contact_point": {
        "email": "text",
        "id": "text",
        "name": "text",
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        }
      },
      "created_at": "2024-05-09T04:25:36.224Z",
      "deleted": "2024-05-09T04:25:36.224Z",
      "description": "text",
      "featured": false,
      "frequency": "unknown",
      "frequency_date": "2024-05-09T04:25:36.224Z",
      "harvest": {
        "archived": "text",
        "archived_at": "2024-05-09T04:25:36.224Z",
        "backend": "text",
        "ckan_name": "text",
        "ckan_source": "text",
        "created_at": "2024-05-09T04:25:36.224Z",
        "dct_identifier": "text",
        "domain": "text",
        "last_update": "2024-05-09T04:25:36.224Z",
        "modified_at": "2024-05-09T04:25:36.224Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2024-05-09T04:25:36.224Z",
        "last_modified_internal": "2024-05-09T04:25:36.224Z"
      },
      "last_modified": "2024-05-09T04:25:36.224Z",
      "last_update": "2024-05-09T04:25:36.224Z",
      "license": "notspecified",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "page": "text",
      "private": false,
      "resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-05-09T04:25:36.224Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-05-09T04:25:36.224Z",
            "modified_at": "2024-05-09T04:25:36.224Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-05-09T04:25:36.224Z",
            "last_modified_internal": "2024-05-09T04:25:36.224Z"
          },
          "last_modified": "2024-05-09T04:25:36.224Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text"
        }
      ],
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "slug": "text",
      "spatial": {
        "geom": {
          "coordinates": [],
          "type": "Point"
        },
        "granularity": "other",
        "zones": [
          "text"
        ]
      },
      "tags": [
        "text"
      ],
      "temporal_coverage": {
        "end": "2024-05-09T04:25:36.224Z",
        "start": "2024-05-09T04:25:36.224Z"
      },
      "title": "text",
      "uri": "text"
    }
  ],
  "next_page": "text",
  "previous_page": "text"
}

List organization discussions

GET//www.data.gouv.fr/api/1/organizations/{org}/discussions/

Path parameters

org*string

Header parameters

Response

Success

Body

class*string

The object class

closedstring (date-time)

The discussion closing date

closed_byall of

The user who closed the discussion

createdstring (date-time)

The discussion creation date

discussionDiscussionMessage (object)

extrasobject

Extra attributes as key-value pairs

idstring

The discussion identifier

spamSpam (object)

subjectall of

The discussion target object

titlestring

The discussion title

urlstring

The discussion API URI

userall of

The discussion author

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/discussions/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "class": "text",
    "closed": "2024-05-09T04:25:36.224Z",
    "closed_by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "created": "2024-05-09T04:25:36.224Z",
    "discussion": {
      "content": "text",
      "posted_by": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "posted_on": "2024-05-09T04:25:36.224Z",
      "spam": {
        "status": "not_checked"
      }
    },
    "id": "text",
    "spam": {
      "status": "not_checked"
    },
    "subject": {
      "class": "text",
      "id": "text"
    },
    "title": "text",
    "url": "text",
    "user": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  }
]

Upload a new logo

POST//www.data.gouv.fr/api/1/organizations/{org}/logo

Path parameters

org*string

The organization ID or slug

Header parameters

Body

filestring (binary)

bboxstring

Response

Success

Body

imagestring

successboolean

Whether the upload succeeded or not.

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/logo', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "image": "text",
  "success": true
}

Set the logo BBox

PUT//www.data.gouv.fr/api/1/organizations/{org}/logo

Path parameters

org*string

The organization ID or slug

Header parameters

Body

filestring (binary)

bboxstring

Response

Success

Body

imagestring

successboolean

Whether the upload succeeded or not.

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/logo', {
    method: 'PUT',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "image": "text",
  "success": true
}

Add a member into a given organization

POST//www.data.gouv.fr/api/1/organizations/{org}/member/{user}

Path parameters

org*string

The organization ID or slug

user*string

Header parameters

Body

role*enum

The member role in the organization

admineditor

userUserReference (all of)

Response

Success

Body

role*enum

The member role in the organization

admineditor

userUserReference (all of)

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/member/{user}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "role": "admin"
    }),
});
const data = await response.json();

Response

{
  "role": "admin",
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  }
}

Update member status into a given organization

PUT//www.data.gouv.fr/api/1/organizations/{org}/member/{user}

Path parameters

org*string

The organization ID or slug

user*string

Header parameters

Body

role*enum

The member role in the organization

admineditor

userUserReference (all of)

Response

Success

Body

role*enum

The member role in the organization

admineditor

userUserReference (all of)

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/member/{user}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "role": "admin"
    }),
});
const data = await response.json();

Response

{
  "role": "admin",
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  }
}

Delete member from an organization

DELETE//www.data.gouv.fr/api/1/organizations/{org}/member/{user}

Path parameters

org*string

The organization ID or slug

user*string

Response

Not Authorized

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/member/{user}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

List membership requests for a given organization

GET//www.data.gouv.fr/api/1/organizations/{org}/membership/

Path parameters

org*string

The organization ID or slug

Query parameters

Header parameters

Response

Success

Body

comment*string

A request comment from the user

createdstring (date-time)

The request creation date

idstring

status*enum

The current request status

pendingacceptedrefused

userUserReference (all of)

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/membership/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "comment": "text",
    "created": "2024-05-09T04:25:36.224Z",
    "id": "text",
    "status": "pending",
    "user": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  }
]

Apply for membership to a given organization

POST//www.data.gouv.fr/api/1/organizations/{org}/membership/

Path parameters

org*string

The organization ID or slug

Header parameters

Response

Success

Body

comment*string

A request comment from the user

createdstring (date-time)

The request creation date

idstring

status*enum

The current request status

pendingacceptedrefused

userUserReference (all of)

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/membership/', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "comment": "text",
  "created": "2024-05-09T04:25:36.224Z",
  "id": "text",
  "status": "pending",
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  }
}

Accept user membership to a given organization

POST//www.data.gouv.fr/api/1/organizations/{org}/membership/{id}/accept/

Path parameters

id*string

org*string

The organization ID or slug

Header parameters

Response

Success

Body

role*enum

The member role in the organization

admineditor

userUserReference (all of)

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/membership/{id}/accept/', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "role": "admin",
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  }
}

Refuse user membership to a given organization

POST//www.data.gouv.fr/api/1/organizations/{org}/membership/{id}/refuse/

Path parameters

id*string

org*string

The organization ID or slug

Body

commentstring

The refusal comment.

Response

Success

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/membership/{id}/refuse/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

List organization reuses (including private ones when member)

GET//www.data.gouv.fr/api/1/organizations/{org}/reuses/

Path parameters

org*string

Header parameters

Response

Success

Body

badgesarray of Badge (object)

The reuse badges

created_atstring (date-time)

The reuse creation date

datasetsarray of Dataset (object)

The reused datasets

deletedstring (date-time)

The organization identifier

description*string (markdown)

The reuse description in Markdown

extrasobject

Extras attributes as key-value pairs

featuredboolean

Is the reuse featured

idstring

The reuse identifier

imagestring

The reuse thumbnail thumbnail (cropped) URL

image_thumbnailstring

The reuse thumbnail thumbnail URL. This is the square (500x500) and cropped version.

last_modifiedstring (date-time)

The reuse last modification date

metricsobject

The reuse metrics

organizationall of

The publishing organization

ownerall of

The owner user

pagestring

The reuse page URL

privateboolean

Is the reuse private to the owner or the organization

slugstring

The reuse permalink string

tagsarray of string

Some keywords to help in search

title*string

The reuse title

topic*enum

The reuse topic

healthtransport_and_mobilityhousing_and_developmentfood_and_agricultureculture_and_recreationeconomy_and_businessenvironment_and_energywork_and_trainingpolitics_and_public_lifesafety_and_securityeducation_and_researchsociety_and_demographylaw_and_justiceopen_data_toolsothers

type*enum

The reuse type

apiapplicationideanews_articlepaperpostvisualizationhardware

uristring

The reuse API URI

url*string

The reuse remote URL (website)

Request

const response = await fetch('//www.data.gouv.fr/api/1/organizations/{org}/reuses/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "badges": [
      {
        "kind": "text"
      }
    ],
    "created_at": "2024-05-09T04:25:36.224Z",
    "datasets": [
      {
        "acronym": "text",
        "archived": "2024-05-09T04:25:36.224Z",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "community_resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2024-05-09T04:25:36.224Z",
            "description": "text",
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2024-05-09T04:25:36.224Z",
              "modified_at": "2024-05-09T04:25:36.224Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2024-05-09T04:25:36.224Z",
              "last_modified_internal": "2024-05-09T04:25:36.224Z"
            },
            "last_modified": "2024-05-09T04:25:36.224Z",
            "latest": "text",
            "mime": "text",
            "preview_url": "text",
            "schema": {
              "name": "text",
              "url": "text",
              "version": "text"
            },
            "title": "text",
            "type": "main",
            "url": "text",
            "dataset": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "page": "text",
              "title": "text",
              "uri": "text"
            },
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ],
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            }
          }
        ],
        "contact_point": {
          "email": "text",
          "id": "text",
          "name": "text",
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "badges": [
              {
                "kind": "text"
              }
            ],
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        },
        "created_at": "2024-05-09T04:25:36.224Z",
        "deleted": "2024-05-09T04:25:36.224Z",
        "description": "text",
        "featured": false,
        "frequency": "unknown",
        "frequency_date": "2024-05-09T04:25:36.224Z",
        "harvest": {
          "archived": "text",
          "archived_at": "2024-05-09T04:25:36.224Z",
          "backend": "text",
          "ckan_name": "text",
          "ckan_source": "text",
          "created_at": "2024-05-09T04:25:36.224Z",
          "dct_identifier": "text",
          "domain": "text",
          "last_update": "2024-05-09T04:25:36.224Z",
          "modified_at": "2024-05-09T04:25:36.224Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2024-05-09T04:25:36.224Z",
          "last_modified_internal": "2024-05-09T04:25:36.224Z"
        },
        "last_modified": "2024-05-09T04:25:36.224Z",
        "last_update": "2024-05-09T04:25:36.224Z",
        "license": "notspecified",
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "page": "text",
        "private": false,
        "resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2024-05-09T04:25:36.224Z",
            "description": "text",
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2024-05-09T04:25:36.224Z",
              "modified_at": "2024-05-09T04:25:36.224Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2024-05-09T04:25:36.224Z",
              "last_modified_internal": "2024-05-09T04:25:36.224Z"
            },
            "last_modified": "2024-05-09T04:25:36.224Z",
            "latest": "text",
            "mime": "text",
            "preview_url": "text",
            "schema": {
              "name": "text",
              "url": "text",
              "version": "text"
            },
            "title": "text",
            "type": "main",
            "url": "text"
          }
        ],
        "schema": {
          "name": "text",
          "url": "text",
          "version": "text"
        },
        "slug": "text",
        "spatial": {
          "geom": {
            "coordinates": [],
            "type": "Point"
          },
          "granularity": "other",
          "zones": [
            "text"
          ]
        },
        "tags": [
          "text"
        ],
        "temporal_coverage": {
          "end": "2024-05-09T04:25:36.224Z",
          "start": "2024-05-09T04:25:36.224Z"
        },
        "title": "text",
        "uri": "text"
      }
    ],
    "deleted": "2024-05-09T04:25:36.224Z",
    "description": "text",
    "featured": false,
    "id": "text",
    "image": "text",
    "image_thumbnail": "text",
    "last_modified": "2024-05-09T04:25:36.224Z",
    "organization": {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "owner": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "page": "text",
    "private": false,
    "slug": "text",
    "tags": [
      "text"
    ],
    "title": "text",
    "topic": "health",
    "type": "api",
    "uri": "text",
    "url": "text"
  }
]

Précédentdiscussions Suivantspatial

Dernière mise à jour il y a 10 mois