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 all available organization badges and their labels

get

Réponses

200

Success

get

GET /api/1/organizations/badges/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

Aucun contenu

List all possible organization roles

get

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/organizations/roles/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

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

Organizations suggest endpoint using mongoDB contains

get

Paramètres de requête

qstringRequis

The string to autocomplete/suggest

sizeintegerOptionnel

The amount of suggestion to fetch

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/organizations/suggest/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

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

List all followers for a given object

get

Paramètres de chemin

idanyRequis

Paramètres de requête

pageintegerOptionnel

The page to fetch

page_sizeintegerOptionnel

The page size to fetch

userstringOptionnel

Filter follower by user, it allows to check if a user is following the object

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/organizations/{id}/followers/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "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": "2025-05-27T14:50:28.013Z"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Follow an object given its ID

post

Returns the number of followers left after the operation

Paramètres de chemin

idanyRequis

Réponses

200

Success

post

POST /api/1/organizations/{id}/followers/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

Aucun contenu

Unfollow an object given its ID

delete

Returns the number of followers left after the operation

Paramètres de chemin

idanyRequis

Réponses

200

Success

delete

DELETE /api/1/organizations/{id}/followers/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

Aucun contenu

Get a organization given its identifier

get

Paramètres de chemin

organyRequis

The organization ID or slug

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

404

Organization not found

410

Organization has been deleted

get

GET /api/1/organizations/{org}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

{
  "acronym": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "business_number_id": "text",
  "created_at": "2025-05-27T14:50:28.013Z",
  "deleted": "2025-05-27T14:50:28.013Z",
  "description": "text",
  "extras": {},
  "id": "text",
  "last_modified": "2025-05-27T14:50:28.013Z",
  "logo": "text",
  "logo_thumbnail": "text",
  "members": [
    {
      "role": "admin",
      "since": "2025-05-27T14:50:28.013Z",
      "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": {}
      }
    }
  ],
  "metrics": {},
  "name": "text",
  "page": "text",
  "slug": "text",
  "uri": "text",
  "url": "text"
}

Delete a organization given its identifier

delete

Paramètres de chemin

organyRequis

The organization ID or slug

Réponses

204

Organization deleted

404

Organization not found

410

Organization has been deleted

delete

DELETE /api/1/organizations/{org}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

Aucun contenu

Delete a badge for a given organization

delete

Paramètres de chemin

badge_kindanyRequis

orgstringRequis

The organization ID or slug

Réponses

200

Success

delete

DELETE /api/1/organizations/{org}/badges/{badge_kind}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

Aucun contenu

get

Paramètres de chemin

organyRequis

The organization ID or slug

Réponses

404

Organization not found

410

Organization has been deleted

get

GET /api/1/organizations/{org}/catalog HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

Aucun contenu

get

Paramètres de chemin

organyRequis

The organization ID or slug

formatanyRequis

Réponses

404

Organization not found

410

Organization has been deleted

get

GET /api/1/organizations/{org}/catalog.{format} HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

Aucun contenu

List organization datasets (including private ones when member)

get

Paramètres de chemin

organyRequis

Paramètres de requête

qstringOptionnel

The search query

sortstring · enumOptionnel

The field (and direction) on which sorting apply

Valeurs possibles:

pageintegerOptionnel

The page to display

page_sizeintegerOptionnel

The page size

tagstring[]Optionnel

licensestringOptionnel

featuredbooleanOptionnel

If set to true, it will filter on featured datasets only. If set to false, it will exclude featured datasets.

geozonestringOptionnel

granularitystringOptionnel

temporal_coveragestringOptionnel

organizationstringOptionnel

organization_badgestring · enumOptionnelValeurs possibles:

ownerstringOptionnel

formatstringOptionnel

schemastringOptionnel

schema_versionstringOptionnel

topicstringOptionnel

creditstringOptionnel

dataservicestringOptionnel

reusestringOptionnel

archivedbooleanOptionnel

If set to true, it will filter on archived datasets only. If set to false, it will exclude archived datasets. User must be authenticated and results are limited to user visibility

deletedbooleanOptionnel

If set to true, it will filter on deleted datasets only. If set to false, it will exclude deleted datasets. User must be authenticated and results are limited to user visibility

privatebooleanOptionnel

If set to true, it will filter on private datasets only. If set to false, it will exclude private datasets. User must be authenticated and results are limited to user visibility

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/organizations/{org}/datasets/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "data": [
    {
      "acronym": "text",
      "archived": "2025-05-27T14:50:28.013Z",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "community_resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2025-05-27T14:50:28.013Z",
          "description": "text",
          "extras": {},
          "filesize": 1,
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2025-05-27T14:50:28.013Z",
            "modified_at": "2025-05-27T14:50:28.013Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2025-05-27T14:50:28.013Z",
            "last_modified_internal": "2025-05-27T14:50:28.013Z"
          },
          "last_modified": "2025-05-27T14:50:28.013Z",
          "latest": "text",
          "metrics": {},
          "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_points": [
        {
          "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"
          },
          "role": "text"
        }
      ],
      "created_at": "2025-05-27T14:50:28.013Z",
      "deleted": "2025-05-27T14:50:28.013Z",
      "description": "text",
      "extras": {},
      "featured": true,
      "frequency": "unknown",
      "frequency_date": "2025-05-27T14:50:28.013Z",
      "harvest": {
        "archived": "text",
        "archived_at": "2025-05-27T14:50:28.013Z",
        "backend": "text",
        "ckan_name": "text",
        "ckan_source": "text",
        "created_at": "2025-05-27T14:50:28.013Z",
        "dct_identifier": "text",
        "domain": "text",
        "last_update": "2025-05-27T14:50:28.013Z",
        "modified_at": "2025-05-27T14:50:28.013Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-05-27T14:50:28.013Z",
        "last_modified_internal": "2025-05-27T14:50:28.013Z"
      },
      "last_modified": "2025-05-27T14:50:28.013Z",
      "last_update": "2025-05-27T14:50:28.013Z",
      "license": "notspecified",
      "metrics": {},
      "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": true,
      "quality": {},
      "resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2025-05-27T14:50:28.013Z",
          "description": "text",
          "extras": {},
          "filesize": 1,
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2025-05-27T14:50:28.013Z",
            "modified_at": "2025-05-27T14:50:28.013Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2025-05-27T14:50:28.013Z",
            "last_modified_internal": "2025-05-27T14:50:28.013Z"
          },
          "last_modified": "2025-05-27T14:50:28.013Z",
          "latest": "text",
          "metrics": {},
          "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": {}
      },
      "tags": [
        "text"
      ],
      "temporal_coverage": {
        "end": "2025-05-27T14:50:28.013Z",
        "start": "2025-05-27T14:50:28.013Z"
      },
      "title": "text",
      "uri": "text"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

List organization discussions

get

Paramètres de chemin

organyRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/organizations/{org}/discussions/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  {
    "class": "text",
    "closed": "2025-05-27T14:50:28.013Z",
    "closed_by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "closed_by_organization": {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "created": "2025-05-27T14:50:28.013Z",
    "discussion": {
      "content": "text",
      "last_modified_at": "2025-05-27T14:50:28.013Z",
      "permissions": {
        "delete": true,
        "edit": true
      },
      "posted_by": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "posted_by_organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "posted_on": "2025-05-27T14:50:28.013Z",
      "spam": {
        "status": "not_checked"
      }
    },
    "extras": {},
    "id": "text",
    "organization": {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "permissions": {
      "close": true,
      "delete": true,
      "edit": true
    },
    "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"
    }
  }
]

Delete member from an organization

delete

Paramètres de chemin

organyRequis

The organization ID or slug

useranyRequis

Réponses

403

Not Authorized

delete

DELETE /api/1/organizations/{org}/member/{user} HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

403

Not Authorized

Aucun contenu

List membership requests for a given organization

get

Paramètres de chemin

organyRequis

The organization ID or slug

Paramètres de requête

statusstringOptionnel

If provided, only return requests in a given status

userstringOptionnel

If provided, only return requests for this user

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

403

Not Authorized

get

GET /api/1/organizations/{org}/membership/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

[
  {
    "comment": "text",
    "created": "2025-05-27T14:50:28.013Z",
    "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",
      "email": {},
      "last_login_at": {}
    }
  }
]

Apply for membership to a given organization

post

Paramètres de chemin

organyRequis

The organization ID or slug

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

post

POST /api/1/organizations/{org}/membership/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "comment": "text",
  "created": "2025-05-27T14:50:28.013Z",
  "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",
    "email": {},
    "last_login_at": {}
  }
}

Accept user membership to a given organization

post

Paramètres de chemin

idanyRequis

orgstringRequis

The organization ID or slug

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

post

POST /api/1/organizations/{org}/membership/{id}/accept/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "role": "admin",
  "since": "2025-05-27T14:50:28.013Z",
  "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": {}
  }
}

List organization reuses (including private ones when member)

get

Paramètres de chemin

organyRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/organizations/{org}/reuses/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  {
    "archived": "2025-05-27T14:50:28.013Z",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "created_at": "2025-05-27T14:50:28.013Z",
    "datasets": [
      {
        "acronym": "text",
        "archived": "2025-05-27T14:50:28.013Z",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "community_resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2025-05-27T14:50:28.013Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2025-05-27T14:50:28.013Z",
              "modified_at": "2025-05-27T14:50:28.013Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2025-05-27T14:50:28.013Z",
              "last_modified_internal": "2025-05-27T14:50:28.013Z"
            },
            "last_modified": "2025-05-27T14:50:28.013Z",
            "latest": "text",
            "metrics": {},
            "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_points": [
          {
            "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"
            },
            "role": "text"
          }
        ],
        "created_at": "2025-05-27T14:50:28.013Z",
        "deleted": "2025-05-27T14:50:28.013Z",
        "description": "text",
        "extras": {},
        "featured": true,
        "frequency": "unknown",
        "frequency_date": "2025-05-27T14:50:28.013Z",
        "harvest": {
          "archived": "text",
          "archived_at": "2025-05-27T14:50:28.013Z",
          "backend": "text",
          "ckan_name": "text",
          "ckan_source": "text",
          "created_at": "2025-05-27T14:50:28.013Z",
          "dct_identifier": "text",
          "domain": "text",
          "last_update": "2025-05-27T14:50:28.013Z",
          "modified_at": "2025-05-27T14:50:28.013Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2025-05-27T14:50:28.013Z",
          "last_modified_internal": "2025-05-27T14:50:28.013Z"
        },
        "last_modified": "2025-05-27T14:50:28.013Z",
        "last_update": "2025-05-27T14:50:28.013Z",
        "license": "notspecified",
        "metrics": {},
        "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": true,
        "quality": {},
        "resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2025-05-27T14:50:28.013Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2025-05-27T14:50:28.013Z",
              "modified_at": "2025-05-27T14:50:28.013Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2025-05-27T14:50:28.013Z",
              "last_modified_internal": "2025-05-27T14:50:28.013Z"
            },
            "last_modified": "2025-05-27T14:50:28.013Z",
            "latest": "text",
            "metrics": {},
            "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": {}
        },
        "tags": [
          "text"
        ],
        "temporal_coverage": {
          "end": "2025-05-27T14:50:28.013Z",
          "start": "2025-05-27T14:50:28.013Z"
        },
        "title": "text",
        "uri": "text"
      }
    ],
    "deleted": "2025-05-27T14:50:28.013Z",
    "description": "text",
    "extras": {},
    "featured": true,
    "id": "text",
    "image": "text",
    "image_thumbnail": "text",
    "last_modified": "2025-05-27T14:50:28.013Z",
    "metrics": {},
    "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": true,
    "slug": "text",
    "tags": [
      "text"
    ],
    "title": "text",
    "topic": "health",
    "type": "api",
    "uri": "text",
    "url": "text"
  }
]

List or search all organizations

get

Paramètres de requête

qstringOptionnel

The search query

sortstring · enumOptionnel

The field (and direction) on which sorting apply

Valeurs possibles:

pageintegerOptionnel

The page to display

page_sizeintegerOptionnel

The page size

badgestring · enumOptionnelValeurs possibles:

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

get

GET /api/1/organizations/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "data": [
    {
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "business_number_id": "text",
      "created_at": "2025-05-27T14:50:28.013Z",
      "deleted": "2025-05-27T14:50:28.013Z",
      "description": "text",
      "extras": {},
      "id": "text",
      "last_modified": "2025-05-27T14:50:28.013Z",
      "logo": "text",
      "logo_thumbnail": "text",
      "members": [
        {
          "role": "admin",
          "since": "2025-05-27T14:50:28.013Z",
          "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": {}
          }
        }
      ],
      "metrics": {},
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text",
      "url": "text"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Create a new organization

post

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

acronymstringOptionnel

The organization acronym

business_number_idstringOptionnel

The organization's business identification number.

created_atstring · date-timeLecture seuleOptionnel

The organization creation date

deletedstring · date-timeLecture seuleOptionnel

The organization deletion date if deleted

descriptionstring · markdownRequis

The organization description in Markdown

extrasobjectOptionnel

Extras attributes as key-value pairs

idstringRequis

The organization identifier

last_modifiedstring · date-timeLecture seuleOptionnel

The organization last modification date

logostringOptionnel

The organization logo URL

logo_thumbnailstringOptionnel

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

metricsobjectLecture seuleOptionnel

The organization metrics

namestringRequis

The organization name

pagestringLecture seuleOptionnel

The organization page URL

slugstringRequis

The organization string used as permalink

uristringLecture seuleOptionnel

The organization API URI

urlstringOptionnel

The organization website URL

Réponses

201

Success

application/json

400

Validation error

post

POST /api/1/organizations/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 304

{
  "acronym": "text",
  "business_number_id": "text",
  "description": "text",
  "extras": {},
  "id": "text",
  "logo": "text",
  "logo_thumbnail": "text",
  "members": [
    {
      "role": "admin",
      "user": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ],
  "name": "text",
  "slug": "text",
  "url": "text"
}

{
  "acronym": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "business_number_id": "text",
  "created_at": "2025-05-27T14:50:28.013Z",
  "deleted": "2025-05-27T14:50:28.013Z",
  "description": "text",
  "extras": {},
  "id": "text",
  "last_modified": "2025-05-27T14:50:28.013Z",
  "logo": "text",
  "logo_thumbnail": "text",
  "members": [
    {
      "role": "admin",
      "since": "2025-05-27T14:50:28.013Z",
      "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": {}
      }
    }
  ],
  "metrics": {},
  "name": "text",
  "page": "text",
  "slug": "text",
  "uri": "text",
  "url": "text"
}

Update a organization given its identifier

put

Paramètres de chemin

organyRequis

The organization ID or slug

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

acronymstringOptionnel

The organization acronym

business_number_idstringOptionnel

The organization's business identification number.

created_atstring · date-timeLecture seuleOptionnel

The organization creation date

deletedstring · date-timeLecture seuleOptionnel

The organization deletion date if deleted

descriptionstring · markdownRequis

The organization description in Markdown

extrasobjectOptionnel

Extras attributes as key-value pairs

idstringRequis

The organization identifier

last_modifiedstring · date-timeLecture seuleOptionnel

The organization last modification date

logostringOptionnel

The organization logo URL

logo_thumbnailstringOptionnel

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

metricsobjectLecture seuleOptionnel

The organization metrics

namestringRequis

The organization name

pagestringLecture seuleOptionnel

The organization page URL

slugstringRequis

The organization string used as permalink

uristringLecture seuleOptionnel

The organization API URI

urlstringOptionnel

The organization website URL

Réponses

200

Success

application/json

400

Validation error: your data cannot be updated for now, we have been notified of the error and we will fix it as soon as possible.

403

Error occuring when the user does not have the required permissions

404

Organization not found

410

Organization has been deleted

put

PUT /api/1/organizations/{org}/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 304

{
  "acronym": "text",
  "business_number_id": "text",
  "description": "text",
  "extras": {},
  "id": "text",
  "logo": "text",
  "logo_thumbnail": "text",
  "members": [
    {
      "role": "admin",
      "user": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ],
  "name": "text",
  "slug": "text",
  "url": "text"
}

{
  "acronym": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "business_number_id": "text",
  "created_at": "2025-05-27T14:50:28.013Z",
  "deleted": "2025-05-27T14:50:28.013Z",
  "description": "text",
  "extras": {},
  "id": "text",
  "last_modified": "2025-05-27T14:50:28.013Z",
  "logo": "text",
  "logo_thumbnail": "text",
  "members": [
    {
      "role": "admin",
      "since": "2025-05-27T14:50:28.013Z",
      "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": {}
      }
    }
  ],
  "metrics": {},
  "name": "text",
  "page": "text",
  "slug": "text",
  "uri": "text",
  "url": "text"
}

Create a new badge for a given organization

post

Paramètres de chemin

orgstringRequis

The organization ID or slug

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

kindstringRequis

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

Réponses

200

Success

application/json

post

POST /api/1/organizations/{org}/badges/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "kind": "text"
}

200

Success

{
  "kind": "text"
}

Add a member into a given organization

post

Paramètres de chemin

organyRequis

The organization ID or slug

useranyRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

rolestring · enumRequis

The member role in the organization

Default: editorExample: adminValeurs possibles:

sincestring · date-timeLecture seuleOptionnel

The date the user joined the organization

userall ofOptionnel

Réponses

201

Success

application/json

403

Not Authorized

409

User is already member

application/json

post

POST /api/1/organizations/{org}/member/{user} HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 121

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

{
  "role": "admin",
  "since": "2025-05-27T14:50:28.013Z",
  "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": {}
  }
}

Update member status into a given organization

put

Paramètres de chemin

organyRequis

The organization ID or slug

useranyRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

rolestring · enumRequis

The member role in the organization

Default: editorExample: adminValeurs possibles:

sincestring · date-timeLecture seuleOptionnel

The date the user joined the organization

userall ofOptionnel

Réponses

200

Success

application/json

403

Not Authorized

put

PUT /api/1/organizations/{org}/member/{user} HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 121

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

{
  "role": "admin",
  "since": "2025-05-27T14:50:28.013Z",
  "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": {}
  }
}

Refuse user membership to a given organization

post

Paramètres de chemin

idanyRequis

orgstringRequis

The organization ID or slug

Corps

commentstringOptionnel

The refusal comment.

Réponses

200

Success

post

POST /api/1/organizations/{org}/membership/{id}/refuse/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "comment": "text"
}

200

Success

Aucun contenu