organizations

Organization related operations

Précédentdiscussions Suivantspatial

Dernière mise à jour il y a 1 an

Cet article vous a-t-il été utile ?

List or search all organizations

get

/organizations/

Query parameters

qstring

The search query

sortstring · enum

The field (and direction) on which sorting apply

Options: name, reuses, datasets, followers, views, created, last_modified, -name, -reuses, -datasets, -followers, -views, -created, -last_modified

pageinteger · default: 1

The page to display

page_sizeinteger · default: 20

The page size

badgestring · enum

Options: public-service, certified, association, company, local-authority

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//www.data.gouv.fr/api/1/organizations/'

200

{
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1,
  "data": [
    {
      "acronym": "text",
      "business_number_id": "text",
      "created_at": "2025-02-20T19:22:59.792Z",
      "deleted": "2025-02-20T19:22:59.792Z",
      "description": "text",
      "extras": {},
      "id": "text",
      "last_modified": "2025-02-20T19:22:59.792Z",
      "logo": "text",
      "logo_thumbnail": "text",
      "metrics": {},
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text",
      "url": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "members": [
        {
          "since": "2025-02-20T19:22:59.792Z",
          "user": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text",
            "email": {},
            "last_login_at": {}
          },
          "role": "admin"
        }
      ]
    }
  ]
}

Success

Create a new organization

post

/organizations/

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

acronymstring

The organization acronym

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

descriptionstring · markdownrequired

The organization description in Markdown

extrasobject

Extras attributes as key-value pairs

idstringrequired

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.

metricsobject

The organization metrics

namestringrequired

The organization name

pagestring

The organization page URL

slugstringrequired

The organization string used as permalink

uristring

The organization API URI

urlstring

The organization website URL

badgesobject[]

The organization badges

membersall of[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/organizations/' \
  --header 'Content-Type: application/json' \
  --data '{"description":"text","extras":{},"id":"text","metrics":{},"name":"text","slug":"text","badges":[{"kind":"text"}],"members":[{"since":"2025-02-20T19:22:59.792Z","user":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text","email":{},"last_login_at":{}},"role":"admin"}]}'

201

400

{
  "acronym": "text",
  "business_number_id": "text",
  "created_at": "2025-02-20T19:22:59.792Z",
  "deleted": "2025-02-20T19:22:59.792Z",
  "description": "text",
  "extras": {},
  "id": "text",
  "last_modified": "2025-02-20T19:22:59.792Z",
  "logo": "text",
  "logo_thumbnail": "text",
  "metrics": {},
  "name": "text",
  "page": "text",
  "slug": "text",
  "uri": "text",
  "url": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "members": [
    {
      "since": "2025-02-20T19:22:59.792Z",
      "user": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "email": {},
        "last_login_at": {}
      },
      "role": "admin"
    }
  ]
}

Success

List all available organization badges and their labels

get

/organizations/badges/

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//www.data.gouv.fr/api/1/organizations/badges/'

200

No body

Success

List all possible organization roles

get

/organizations/roles/

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//www.data.gouv.fr/api/1/organizations/roles/'

200

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

Success

Organizations suggest endpoint using mongoDB contains

get

/organizations/suggest/

Query parameters

qstringrequired

The string to autocomplete/suggest

sizeinteger · default: 10

The amount of suggestion to fetch

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//www.data.gouv.fr/api/1/organizations/suggest/?q=text'

200

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

Success

List all followers for a given object

get

/organizations/{id}/followers/

Path parameters

idstringrequired

Query parameters

pageinteger · default: 1

The page to fetch

page_sizeinteger · default: 20

The page size to fetch

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//www.data.gouv.fr/api/1/organizations/{id}/followers/'

200

{
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1,
  "data": [
    {
      "id": "text",
      "since": "2025-02-20T19:22:59.792Z",
      "follower": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ]
}

Success

Follow an object given its ID

Returns the number of followers left after the operation

post

/organizations/{id}/followers/

Path parameters

idstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/organizations/{id}/followers/'

200

No body

Success

Unfollow an object given its ID

Returns the number of followers left after the operation

delete

/organizations/{id}/followers/

Path parameters

idstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '//www.data.gouv.fr/api/1/organizations/{id}/followers/'

200

No body

Success

Get a organization given its identifier

get

/organizations/{org}//

Path parameters

orgstringrequired

The organization ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/'

200

404

410

{
  "acronym": "text",
  "business_number_id": "text",
  "created_at": "2025-02-20T19:22:59.792Z",
  "deleted": "2025-02-20T19:22:59.792Z",
  "description": "text",
  "extras": {},
  "id": "text",
  "last_modified": "2025-02-20T19:22:59.792Z",
  "logo": "text",
  "logo_thumbnail": "text",
  "metrics": {},
  "name": "text",
  "page": "text",
  "slug": "text",
  "uri": "text",
  "url": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "members": [
    {
      "since": "2025-02-20T19:22:59.792Z",
      "user": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "email": {},
        "last_login_at": {}
      },
      "role": "admin"
    }
  ]
}

Success

Update a organization given its identifier

put

/organizations/{org}//

Path parameters

orgstringrequired

The organization ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

acronymstring

The organization acronym

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

descriptionstring · markdownrequired

The organization description in Markdown

extrasobject

Extras attributes as key-value pairs

idstringrequired

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.

metricsobject

The organization metrics

namestringrequired

The organization name

pagestring

The organization page URL

slugstringrequired

The organization string used as permalink

uristring

The organization API URI

urlstring

The organization website URL

badgesobject[]

The organization badges

membersall of[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/' \
  --header 'Content-Type: application/json' \
  --data '{"description":"text","extras":{},"id":"text","metrics":{},"name":"text","slug":"text","badges":[{"kind":"text"}],"members":[{"since":"2025-02-20T19:22:59.792Z","user":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text","email":{},"last_login_at":{}},"role":"admin"}]}'

200

400

403

404

410

{
  "acronym": "text",
  "business_number_id": "text",
  "created_at": "2025-02-20T19:22:59.792Z",
  "deleted": "2025-02-20T19:22:59.792Z",
  "description": "text",
  "extras": {},
  "id": "text",
  "last_modified": "2025-02-20T19:22:59.792Z",
  "logo": "text",
  "logo_thumbnail": "text",
  "metrics": {},
  "name": "text",
  "page": "text",
  "slug": "text",
  "uri": "text",
  "url": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "members": [
    {
      "since": "2025-02-20T19:22:59.792Z",
      "user": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "email": {},
        "last_login_at": {}
      },
      "role": "admin"
    }
  ]
}

Success

Delete a organization given its identifier

delete

/organizations/{org}//

Path parameters

orgstringrequired

The organization ID or slug

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/'

204

404

410

No body

Organization deleted

Create a new badge for a given organization

post

/organizations/{org}/badges/

Path parameters

orgstringrequired

The organization ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

kindstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/badges/' \
  --header 'Content-Type: application/json' \
  --data '{"kind":"text"}'

200

{
  "kind": "text"
}

Success

Delete a badge for a given organization

delete

/organizations/{org}/badges/{badge_kind}//

Path parameters

badge_kindstringrequired

orgstringrequired

The organization ID or slug

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/badges/{badge_kind}/'

200

No body

Success

get

/organizations/{org}/catalog

Path parameters

orgstringrequired

The organization ID or slug

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/catalog'

404

410

No body

Organization not found

get

/organizations/{org}/catalog.{format}

Path parameters

orgstringrequired

The organization ID or slug

formatstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/catalog.{format}'

404

410

No body

Organization not found

List organization datasets (including private ones when member)

get

/organizations/{org}/datasets/

Path parameters

orgstringrequired

Query parameters

qstring

The search query

sortstring · enum

The field (and direction) on which sorting apply

Options: title, created, last_update, reuses, followers, views, -title, -created, -last_update, -reuses, -followers, -views

pageinteger · default: 1

The page to display

page_sizeinteger · default: 20

The page size

tagstring[]

licensestring

featuredboolean

geozonestring

granularitystring

temporal_coveragestring

organizationstring

organization_badgestring · enum

Options: public-service, certified, association, company, local-authority

ownerstring

formatstring

schemastring

schema_versionstring

topicstring

creditstring

dataservicestring

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/datasets/'

200

{
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1,
  "data": [
    {
      "acronym": "text",
      "archived": "2025-02-20T19:22:59.792Z",
      "created_at": "2025-02-20T19:22:59.792Z",
      "deleted": "2025-02-20T19:22:59.792Z",
      "description": "text",
      "extras": {},
      "featured": true,
      "frequency_date": "2025-02-20T19:22:59.792Z",
      "id": "text",
      "last_modified": "2025-02-20T19:22:59.792Z",
      "last_update": "2025-02-20T19:22:59.792Z",
      "license": "notspecified",
      "metrics": {},
      "page": "text",
      "private": true,
      "quality": {},
      "slug": "text",
      "title": "text",
      "uri": "text",
      "frequency": "unknown",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "harvest": {
        "archived": "text",
        "archived_at": "2025-02-20T19:22:59.792Z",
        "backend": "text",
        "ckan_name": "text",
        "ckan_source": "text",
        "created_at": "2025-02-20T19:22:59.792Z",
        "dct_identifier": "text",
        "domain": "text",
        "last_update": "2025-02-20T19:22:59.792Z",
        "modified_at": "2025-02-20T19:22:59.792Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "uri": "text"
      },
      "internal": {
        "created_at_internal": "2025-02-20T19:22:59.792Z",
        "last_modified_internal": "2025-02-20T19:22:59.792Z"
      },
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "badges": [
          {
            "kind": "text"
          }
        ]
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "spatial": {
        "granularity": "other",
        "zones": [
          "text"
        ],
        "geom": {
          "type": "Point",
          "coordinates": [
            {}
          ]
        }
      },
      "temporal_coverage": {
        "end": "2025-02-20T19:22:59.792Z",
        "start": "2025-02-20T19:22:59.792Z"
      },
      "community_resources": [
        {
          "created_at": "2025-02-20T19:22:59.792Z",
          "description": "text",
          "extras": {},
          "filesize": 1,
          "format": "text",
          "id": "text",
          "last_modified": "2025-02-20T19:22:59.792Z",
          "latest": "text",
          "metrics": {},
          "mime": "text",
          "preview_url": "text",
          "title": "text",
          "url": "text",
          "filetype": "file",
          "type": "main",
          "checksum": {
            "value": "text",
            "type": "sha1"
          },
          "harvest": {
            "created_at": "2025-02-20T19:22:59.792Z",
            "modified_at": "2025-02-20T19:22:59.792Z",
            "uri": "text"
          },
          "internal": {
            "created_at_internal": "2025-02-20T19:22:59.792Z",
            "last_modified_internal": "2025-02-20T19:22:59.792Z"
          },
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "dataset": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "page": "text",
            "title": "text",
            "uri": "text"
          },
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text",
            "badges": [
              {
                "kind": "text"
              }
            ]
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        }
      ],
      "contact_points": [
        {
          "contact_form": "text",
          "email": "text",
          "id": "text",
          "name": "text",
          "role": "text",
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text",
            "badges": [
              {
                "kind": "text"
              }
            ]
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        }
      ],
      "resources": [
        {
          "created_at": "2025-02-20T19:22:59.792Z",
          "description": "text",
          "extras": {},
          "filesize": 1,
          "format": "text",
          "id": "text",
          "last_modified": "2025-02-20T19:22:59.792Z",
          "latest": "text",
          "metrics": {},
          "mime": "text",
          "preview_url": "text",
          "title": "text",
          "url": "text",
          "filetype": "file",
          "type": "main",
          "checksum": {
            "value": "text",
            "type": "sha1"
          },
          "harvest": {
            "created_at": "2025-02-20T19:22:59.792Z",
            "modified_at": "2025-02-20T19:22:59.792Z",
            "uri": "text"
          },
          "internal": {
            "created_at_internal": "2025-02-20T19:22:59.792Z",
            "last_modified_internal": "2025-02-20T19:22:59.792Z"
          },
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          }
        }
      ]
    }
  ]
}

Success

List organization discussions

get

/organizations/{org}/discussions/

Path parameters

orgstringrequired

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/discussions/'

200

[
  {
    "class": "text",
    "closed": "2025-02-20T19:22:59.792Z",
    "created": "2025-02-20T19:22:59.792Z",
    "discussion": {
      "content": "text",
      "posted_on": "2025-02-20T19:22:59.792Z",
      "spam": {
        "status": "not_checked"
      },
      "posted_by": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    },
    "extras": {},
    "id": "text",
    "spam": {
      "status": "not_checked"
    },
    "title": "text",
    "url": "text",
    "closed_by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "subject": {
      "class": "text",
      "id": "text"
    },
    "user": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  }
]

Success

Add a member into a given organization

post

/organizations/{org}/member/{user}

Path parameters

orgstringrequired

The organization ID or slug

userstringrequired

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

sincestring · date-time

The date the user joined the organization

userall of

rolestring · enum · default: editorrequired

The member role in the organization

Example: admin

Options: admin, editor

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/member/{user}' \
  --header 'Content-Type: application/json' \
  --data '{"user":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text","email":{},"last_login_at":{}},"role":"admin"}'

201

403

409

{
  "since": "2025-02-20T19:22:59.792Z",
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "email": {},
    "last_login_at": {}
  },
  "role": "admin"
}

Success

Update member status into a given organization

put

/organizations/{org}/member/{user}

Path parameters

orgstringrequired

The organization ID or slug

userstringrequired

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

sincestring · date-time

The date the user joined the organization

userall of

rolestring · enum · default: editorrequired

The member role in the organization

Example: admin

Options: admin, editor

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/member/{user}' \
  --header 'Content-Type: application/json' \
  --data '{"user":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text","email":{},"last_login_at":{}},"role":"admin"}'

200

403

{
  "since": "2025-02-20T19:22:59.792Z",
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "email": {},
    "last_login_at": {}
  },
  "role": "admin"
}

Success

Delete member from an organization

delete

/organizations/{org}/member/{user}

Path parameters

orgstringrequired

The organization ID or slug

userstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/member/{user}'

403

No body

Not Authorized

List membership requests for a given organization

get

/organizations/{org}/membership/

Path parameters

orgstringrequired

The organization ID or slug

Query parameters

statusstring

If provided, only return requests in a given status

userstring

If provided, only return requests for this user

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/membership/'

200

403

[
  {
    "comment": "text",
    "created": "2025-02-20T19:22:59.792Z",
    "id": "text",
    "user": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text",
      "email": {},
      "last_login_at": {}
    },
    "status": "pending"
  }
]

Success

Apply for membership to a given organization

post

/organizations/{org}/membership/

Path parameters

orgstringrequired

The organization ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/membership/'

200

{
  "comment": "text",
  "created": "2025-02-20T19:22:59.792Z",
  "id": "text",
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "email": {},
    "last_login_at": {}
  },
  "status": "pending"
}

Success

Accept user membership to a given organization

post

/organizations/{org}/membership/{id}/accept/

Path parameters

idstringrequired

orgstringrequired

The organization ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/membership/{id}/accept/'

200

{
  "since": "2025-02-20T19:22:59.792Z",
  "user": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "email": {},
    "last_login_at": {}
  },
  "role": "admin"
}

Success

Refuse user membership to a given organization

post

/organizations/{org}/membership/{id}/refuse/

Path parameters

idstringrequired

orgstringrequired

The organization ID or slug

Body

commentstring

The refusal comment.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/membership/{id}/refuse/' \
  --header 'Content-Type: application/json'

200

No body

Success

List organization reuses (including private ones when member)

get

/organizations/{org}/reuses/

Path parameters

orgstringrequired

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//www.data.gouv.fr/api/1/organizations/{org}/reuses/'

200

[
  {
    "archived": "2025-02-20T19:22:59.792Z",
    "created_at": "2025-02-20T19:22:59.792Z",
    "deleted": "2025-02-20T19:22:59.792Z",
    "description": "text",
    "extras": {},
    "featured": true,
    "id": "text",
    "image": "text",
    "image_thumbnail": "text",
    "last_modified": "2025-02-20T19:22:59.792Z",
    "metrics": {},
    "page": "text",
    "private": true,
    "slug": "text",
    "title": "text",
    "uri": "text",
    "url": "text",
    "topic": "health",
    "type": "api",
    "datasets": [
      {
        "acronym": "text",
        "archived": "2025-02-20T19:22:59.792Z",
        "created_at": "2025-02-20T19:22:59.792Z",
        "deleted": "2025-02-20T19:22:59.792Z",
        "description": "text",
        "extras": {},
        "featured": true,
        "frequency_date": "2025-02-20T19:22:59.792Z",
        "id": "text",
        "last_modified": "2025-02-20T19:22:59.792Z",
        "last_update": "2025-02-20T19:22:59.792Z",
        "license": "notspecified",
        "metrics": {},
        "page": "text",
        "private": true,
        "quality": {},
        "slug": "text",
        "title": "text",
        "uri": "text",
        "frequency": "unknown",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "tags": [
          "text"
        ],
        "harvest": {
          "archived": "text",
          "archived_at": "2025-02-20T19:22:59.792Z",
          "backend": "text",
          "ckan_name": "text",
          "ckan_source": "text",
          "created_at": "2025-02-20T19:22:59.792Z",
          "dct_identifier": "text",
          "domain": "text",
          "last_update": "2025-02-20T19:22:59.792Z",
          "modified_at": "2025-02-20T19:22:59.792Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "internal": {
          "created_at_internal": "2025-02-20T19:22:59.792Z",
          "last_modified_internal": "2025-02-20T19:22:59.792Z"
        },
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text",
          "badges": [
            {
              "kind": "text"
            }
          ]
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "schema": {
          "name": "text",
          "url": "text",
          "version": "text"
        },
        "spatial": {
          "granularity": "other",
          "zones": [
            "text"
          ],
          "geom": {
            "type": "Point",
            "coordinates": [
              {}
            ]
          }
        },
        "temporal_coverage": {
          "end": "2025-02-20T19:22:59.792Z",
          "start": "2025-02-20T19:22:59.792Z"
        },
        "community_resources": [
          {
            "created_at": "2025-02-20T19:22:59.792Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "format": "text",
            "id": "text",
            "last_modified": "2025-02-20T19:22:59.792Z",
            "latest": "text",
            "metrics": {},
            "mime": "text",
            "preview_url": "text",
            "title": "text",
            "url": "text",
            "filetype": "file",
            "type": "main",
            "checksum": {
              "value": "text",
              "type": "sha1"
            },
            "harvest": {
              "created_at": "2025-02-20T19:22:59.792Z",
              "modified_at": "2025-02-20T19:22:59.792Z",
              "uri": "text"
            },
            "internal": {
              "created_at_internal": "2025-02-20T19:22:59.792Z",
              "last_modified_internal": "2025-02-20T19:22:59.792Z"
            },
            "schema": {
              "name": "text",
              "url": "text",
              "version": "text"
            },
            "dataset": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "page": "text",
              "title": "text",
              "uri": "text"
            },
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ]
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            }
          }
        ],
        "contact_points": [
          {
            "contact_form": "text",
            "email": "text",
            "id": "text",
            "name": "text",
            "role": "text",
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ]
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            }
          }
        ],
        "resources": [
          {
            "created_at": "2025-02-20T19:22:59.792Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "format": "text",
            "id": "text",
            "last_modified": "2025-02-20T19:22:59.792Z",
            "latest": "text",
            "metrics": {},
            "mime": "text",
            "preview_url": "text",
            "title": "text",
            "url": "text",
            "filetype": "file",
            "type": "main",
            "checksum": {
              "value": "text",
              "type": "sha1"
            },
            "harvest": {
              "created_at": "2025-02-20T19:22:59.792Z",
              "modified_at": "2025-02-20T19:22:59.792Z",
              "uri": "text"
            },
            "internal": {
              "created_at_internal": "2025-02-20T19:22:59.792Z",
              "last_modified_internal": "2025-02-20T19:22:59.792Z"
            },
            "schema": {
              "name": "text",
              "url": "text",
              "version": "text"
            }
          }
        ]
      }
    ],
    "tags": [
      "text"
    ],
    "organization": {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text",
      "badges": [
        {
          "kind": "text"
        }
      ]
    },
    "owner": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "badges": [
      {
        "kind": "text"
      }
    ]
  }
]

Success