organizations

Organization related operations

List or search all organizations

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

Query parameters

Header parameters

Response

200

Success

Body

application/json

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

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "business_number_id": "text",
      "created_at": "2024-11-21T11:40:24.952Z",
      "deleted": "2024-11-21T11:40:24.952Z",
      "description": "text",
      "id": "text",
      "last_modified": "2024-11-21T11:40:24.952Z",
      "logo": "text",
      "logo_thumbnail": "text",
      "members": [
        {
          "role": "admin",
          "since": "2024-11-21T11:40:24.952Z",
          "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

application/json

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

201400

Success

Body

application/json

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

JavaScriptCurlPython

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

201

{
  "acronym": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "business_number_id": "text",
  "created_at": "2024-11-21T11:40:24.952Z",
  "deleted": "2024-11-21T11:40:24.952Z",
  "description": "text",
  "id": "text",
  "last_modified": "2024-11-21T11:40:24.952Z",
  "logo": "text",
  "logo_thumbnail": "text",
  "members": [
    {
      "role": "admin",
      "since": "2024-11-21T11:40:24.952Z",
      "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

200

Success

Request

JavaScriptCurlPython

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

200

Success

Body

application/json

idstring

The role identifier

labelstring

The role label

Request

JavaScriptCurlPython

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

Response

200

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

Organizations suggest endpoint using mongoDB contains

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

Query parameters

Header parameters

Response

200

Success

Body

application/json

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

JavaScriptCurlPython

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

Response

200

[
  {
    "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

200

Success

Body

application/json

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

JavaScriptCurlPython

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

Response

200

{
  "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-11-21T11:40:24.952Z"
    }
  ],
  "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

200

Success

Request

JavaScriptCurlPython

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

200

Success

Request

JavaScriptCurlPython

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

200404410

Success

Body

application/json

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

JavaScriptCurlPython

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

Response

200

{
  "acronym": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "business_number_id": "text",
  "created_at": "2024-11-21T11:40:24.952Z",
  "deleted": "2024-11-21T11:40:24.952Z",
  "description": "text",
  "id": "text",
  "last_modified": "2024-11-21T11:40:24.952Z",
  "logo": "text",
  "logo_thumbnail": "text",
  "members": [
    {
      "role": "admin",
      "since": "2024-11-21T11:40:24.952Z",
      "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

application/json

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

200400403404410

Success

Body

application/json

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

JavaScriptCurlPython

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

200403

{
  "acronym": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "business_number_id": "text",
  "created_at": "2024-11-21T11:40:24.952Z",
  "deleted": "2024-11-21T11:40:24.952Z",
  "description": "text",
  "id": "text",
  "last_modified": "2024-11-21T11:40:24.952Z",
  "logo": "text",
  "logo_thumbnail": "text",
  "members": [
    {
      "role": "admin",
      "since": "2024-11-21T11:40:24.952Z",
      "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

204404410

Organization deleted

Request

JavaScriptCurlPython

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

application/json

kind*string

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

Response

200

Success

Body

application/json

kind*string

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

Request

JavaScriptCurlPython

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

200

{
  "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

200

Success

Request

JavaScriptCurlPython

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

404410

Organization not found

Request

JavaScriptCurlPython

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

404410

Organization not found

Request

JavaScriptCurlPython

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

200

Success

Body

application/json

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

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "acronym": "text",
      "archived": "2024-11-21T11:40:24.952Z",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "community_resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-11-21T11:40:24.952Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-11-21T11:40:24.952Z",
            "modified_at": "2024-11-21T11:40:24.952Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-11-21T11:40:24.952Z",
            "last_modified_internal": "2024-11-21T11:40:24.952Z"
          },
          "last_modified": "2024-11-21T11:40:24.952Z",
          "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": {
        "contact_form": "text",
        "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-11-21T11:40:24.952Z",
      "deleted": "2024-11-21T11:40:24.952Z",
      "description": "text",
      "featured": false,
      "frequency": "unknown",
      "frequency_date": "2024-11-21T11:40:24.952Z",
      "harvest": {
        "archived": "text",
        "archived_at": "2024-11-21T11:40:24.952Z",
        "backend": "text",
        "ckan_name": "text",
        "ckan_source": "text",
        "created_at": "2024-11-21T11:40:24.952Z",
        "dct_identifier": "text",
        "domain": "text",
        "last_update": "2024-11-21T11:40:24.952Z",
        "modified_at": "2024-11-21T11:40:24.952Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2024-11-21T11:40:24.952Z",
        "last_modified_internal": "2024-11-21T11:40:24.952Z"
      },
      "last_modified": "2024-11-21T11:40:24.952Z",
      "last_update": "2024-11-21T11:40:24.952Z",
      "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-11-21T11:40:24.952Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-11-21T11:40:24.952Z",
            "modified_at": "2024-11-21T11:40:24.952Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-11-21T11:40:24.952Z",
            "last_modified_internal": "2024-11-21T11:40:24.952Z"
          },
          "last_modified": "2024-11-21T11:40:24.952Z",
          "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-11-21T11:40:24.952Z",
        "start": "2024-11-21T11:40:24.952Z"
      },
      "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

200

Success

Body

application/json

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

JavaScriptCurlPython

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

Response

200

[
  {
    "class": "text",
    "closed": "2024-11-21T11:40:24.952Z",
    "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-11-21T11:40:24.952Z",
    "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-11-21T11:40:24.952Z",
      "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"
    }
  }
]

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

application/json

role*enum

The member role in the organization

Example: "admin"

admineditor

sincestring (date-time)

The date the user joined the organization

userMemberUserWithEmail (all of)

Response

201403409

Success

Body

application/json

role*enum

The member role in the organization

Example: "admin"

admineditor

sincestring (date-time)

The date the user joined the organization

userMemberUserWithEmail (all of)

Request

JavaScriptCurlPython

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

201409

{
  "role": "admin",
  "since": "2024-11-21T11:40:24.952Z",
  "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

application/json

role*enum

The member role in the organization

Example: "admin"

admineditor

sincestring (date-time)

The date the user joined the organization

userMemberUserWithEmail (all of)

Response

200403

Success

Body

application/json

role*enum

The member role in the organization

Example: "admin"

admineditor

sincestring (date-time)

The date the user joined the organization

userMemberUserWithEmail (all of)

Request

JavaScriptCurlPython

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

200

{
  "role": "admin",
  "since": "2024-11-21T11:40:24.952Z",
  "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

403

Not Authorized

Request

JavaScriptCurlPython

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

200403

Success

Body

application/json

comment*string

A request comment from the user

createdstring (date-time)

The request creation date

idstring

status*enum

The current request status

Example: "pending"

pendingacceptedrefused

userMemberUserWithEmail (all of)

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "comment": "text",
    "created": "2024-11-21T11:40:24.952Z",
    "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

200

Success

Body

application/json

comment*string

A request comment from the user

createdstring (date-time)

The request creation date

idstring

status*enum

The current request status

Example: "pending"

pendingacceptedrefused

userMemberUserWithEmail (all of)

Request

JavaScriptCurlPython

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

Response

200

{
  "comment": "text",
  "created": "2024-11-21T11:40:24.952Z",
  "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

200

Success

Body

application/json

role*enum

The member role in the organization

Example: "admin"

admineditor

sincestring (date-time)

The date the user joined the organization

userMemberUserWithEmail (all of)

Request

JavaScriptCurlPython

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

Response

200

{
  "role": "admin",
  "since": "2024-11-21T11:40:24.952Z",
  "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

application/json

commentstring

The refusal comment.

Response

200

Success

Request

JavaScriptCurlPython

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

200

Success

Body

application/json

archivedstring (date-time)

badgesarray of all of

created_at*string (date-time)

datasetsarray of Dataset (object)

deletedstring (date-time)

description*string (markdown)

extrasobject

featuredboolean

id*string

imagestring

URL of the image

image_thumbnailstring

URL of the cropped and squared image (500x500)

last_modified*string (date-time)

metricsobject

organizationall of

Only present if owner is not set. Can only be set to an organization of the current authenticated user.

ownerall of

Only present if organization is not set. Can only be set to the current authenticated user.

pagestring

Link to the udata web page for this reuse

privateboolean

slug*string

tagsarray of string

title*string

topic*enum

Example: "health"

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

Example: "api"

apiapplicationideanews_articlepaperpostvisualizationhardware

uristring

Link to the API endpoint for this reuse

url*string

The remote URL (website)

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "archived": "2024-11-21T11:40:24.952Z",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "created_at": "2024-11-21T11:40:24.952Z",
    "datasets": [
      {
        "acronym": "text",
        "archived": "2024-11-21T11:40:24.952Z",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "community_resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2024-11-21T11:40:24.952Z",
            "description": "text",
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2024-11-21T11:40:24.952Z",
              "modified_at": "2024-11-21T11:40:24.952Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2024-11-21T11:40:24.952Z",
              "last_modified_internal": "2024-11-21T11:40:24.952Z"
            },
            "last_modified": "2024-11-21T11:40:24.952Z",
            "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": {
          "contact_form": "text",
          "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-11-21T11:40:24.952Z",
        "deleted": "2024-11-21T11:40:24.952Z",
        "description": "text",
        "featured": false,
        "frequency": "unknown",
        "frequency_date": "2024-11-21T11:40:24.952Z",
        "harvest": {
          "archived": "text",
          "archived_at": "2024-11-21T11:40:24.952Z",
          "backend": "text",
          "ckan_name": "text",
          "ckan_source": "text",
          "created_at": "2024-11-21T11:40:24.952Z",
          "dct_identifier": "text",
          "domain": "text",
          "last_update": "2024-11-21T11:40:24.952Z",
          "modified_at": "2024-11-21T11:40:24.952Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2024-11-21T11:40:24.952Z",
          "last_modified_internal": "2024-11-21T11:40:24.952Z"
        },
        "last_modified": "2024-11-21T11:40:24.952Z",
        "last_update": "2024-11-21T11:40:24.952Z",
        "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-11-21T11:40:24.952Z",
            "description": "text",
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2024-11-21T11:40:24.952Z",
              "modified_at": "2024-11-21T11:40:24.952Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2024-11-21T11:40:24.952Z",
              "last_modified_internal": "2024-11-21T11:40:24.952Z"
            },
            "last_modified": "2024-11-21T11:40:24.952Z",
            "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-11-21T11:40:24.952Z",
          "start": "2024-11-21T11:40:24.952Z"
        },
        "title": "text",
        "uri": "text"
      }
    ],
    "deleted": "2024-11-21T11:40:24.952Z",
    "description": "text",
    "featured": false,
    "id": "text",
    "image": "text",
    "image_thumbnail": "text",
    "last_modified": "2024-11-21T11:40:24.952Z",
    "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"
  }
]