dataservices

Dataservices related operation (beta)

List or search all dataservices

get

Paramètres de requête

pageintegerOptionnel

The page to fetch

Default: 1

page_sizeintegerOptionnel

The page size to fetch

Default: 20

sortstring · enumOptionnel

The field (and direction) on which sorting apply

Valeurs possibles:

qstringOptionnel

topicstringOptionnel

reusestringOptionnel

ownerstringOptionnel

organizationstringOptionnel

organization_badgestring · my-custom-formatOptionnel

access_typestring · enumOptionnelValeurs possibles:

tagstringOptionnel

featuredbooleanOptionnel

contact_pointstringOptionnel

datasetstringOptionnel

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

next_pagestringOptionnel

The next page URL if exists

pageinteger · min: 1Requis

The current page

page_sizeintegerRequis

The page size used for pagination

previous_pagestringOptionnel

The previous page URL if exists

totalintegerRequis

The total paginated items

get/dataservices/

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

200

Success

{
  "data": [
    {
      "access_audiences": [
        {
          "condition": "yes",
          "role": "local_authority_and_administration"
        }
      ],
      "access_type": "open",
      "access_type_reason": "text",
      "access_type_reason_category": "confidentiality_of_proceedings_of_public_authorities",
      "acronym": "text",
      "archived_at": "2026-07-14T21:26:13.984Z",
      "authorization_request_url": "text",
      "availability": "99.99",
      "availability_url": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "base_api_url": "text",
      "business_documentation_url": "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",
            "permissions": {
              "delete": true,
              "edit": true,
              "harvest": true,
              "members": true,
              "private": true
            },
            "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": "contact"
        }
      ],
      "created_at": "2026-07-14T21:26:13.984Z",
      "datasets": {},
      "deleted_at": "2026-07-14T21:26:13.984Z",
      "description": "text",
      "extras": {},
      "featured": true,
      "format": "REST",
      "harvest": {
        "archived_at": "2026-07-14T21:26:13.984Z",
        "archived_reason": "text",
        "backend": "text",
        "created_at": "2026-07-14T21:26:13.984Z",
        "domain": "text",
        "issued_at": "2026-07-14T21:26:13.984Z",
        "last_update": "2026-07-14T21:26:13.984Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "source_url": "text",
        "uri": "text"
      },
      "id": "text",
      "license": "text",
      "machine_documentation_url": "text",
      "metadata_modified_at": "2026-07-14T21:26:13.984Z",
      "metrics": {},
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "permissions": {
          "delete": true,
          "edit": true,
          "harvest": true,
          "members": true,
          "private": true
        },
        "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"
      },
      "permissions": {
        "delete": true,
        "edit": true
      },
      "private": true,
      "rate_limiting": "text",
      "rate_limiting_url": "text",
      "self_api_url": "text",
      "self_web_url": "text",
      "slug": "text",
      "tags": [
        "text"
      ],
      "technical_documentation_url": "text",
      "title": "My awesome API"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

post

Paramètres de chemin

dataservicestringRequis

The dataservice ID or slug

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corpsobject · DataserviceDatasetsAdd[]

idstringRequis

Id of the dataset to add

Réponses

200

Success

application/json

access_typestring · enumOptionnelExample: openValeurs possibles:

access_type_reasonstringOptionnel

access_type_reason_categorystring · enumOptionnelExample: confidentiality_of_proceedings_of_public_authoritiesValeurs possibles:

acronymstring · max: 128Optionnel

archived_atstring · date-timeOptionnel

authorization_request_urlstringOptionnel

availabilitynumberOptionnelExample: 99.99

availability_urlstringOptionnel

base_api_urlstringOptionnel

business_documentation_urlstringOptionnel

created_atstring · date-timeLecture seuleRequis

datasetsobjectOptionnel

Visit this API link to see the list.

deleted_atstring · date-timeOptionnel

descriptionstring · markdownOptionnel

extrasobjectOptionnel

featuredbooleanLecture seuleOptionnel

formatstring · enumOptionnelExample: RESTValeurs possibles:

idstringLecture seuleRequis

licensestringOptionnel

The ID of the license

machine_documentation_urlstringOptionnel

Swagger link, OpenAPI format, WMS XML…

metadata_modified_atstring · date-timeLecture seuleRequis

metricsobjectLecture seuleOptionnel

privatebooleanOptionnel

Is the dataservice private to the owner or the organization

rate_limitingstringOptionnel

rate_limiting_urlstringOptionnel

self_api_urlstringLecture seuleOptionnel

Link to the API endpoint for this dataservice

self_web_urlstringLecture seuleOptionnel

Link to the udata web page for this dataservice

slugstring · max: 255Lecture seuleRequis

tagsstring[]Optionnel

technical_documentation_urlstringOptionnel

HTML version of a Swagger…

titlestringRequisExample: My awesome API

400

Malformed object id(s) in request

403

Forbidden

404

Dataservice not found

410

Dataservice has been deleted

post/dataservices/{dataservice}/datasets/

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

[
  {
    "id": "text"
  }
]

{
  "access_audiences": [
    {
      "condition": "yes",
      "role": "local_authority_and_administration"
    }
  ],
  "access_type": "open",
  "access_type_reason": "text",
  "access_type_reason_category": "confidentiality_of_proceedings_of_public_authorities",
  "acronym": "text",
  "archived_at": "2026-07-14T21:26:13.984Z",
  "authorization_request_url": "text",
  "availability": "99.99",
  "availability_url": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "base_api_url": "text",
  "business_documentation_url": "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",
        "permissions": {
          "delete": true,
          "edit": true,
          "harvest": true,
          "members": true,
          "private": true
        },
        "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": "contact"
    }
  ],
  "created_at": "2026-07-14T21:26:13.984Z",
  "datasets": {},
  "deleted_at": "2026-07-14T21:26:13.984Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "format": "REST",
  "harvest": {
    "archived_at": "2026-07-14T21:26:13.984Z",
    "archived_reason": "text",
    "backend": "text",
    "created_at": "2026-07-14T21:26:13.984Z",
    "domain": "text",
    "issued_at": "2026-07-14T21:26:13.984Z",
    "last_update": "2026-07-14T21:26:13.984Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "source_url": "text",
    "uri": "text"
  },
  "id": "text",
  "license": "text",
  "machine_documentation_url": "text",
  "metadata_modified_at": "2026-07-14T21:26:13.984Z",
  "metrics": {},
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "permissions": {
      "delete": true,
      "edit": true,
      "harvest": true,
      "members": true,
      "private": true
    },
    "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"
  },
  "permissions": {
    "delete": true,
    "edit": true
  },
  "private": true,
  "rate_limiting": "text",
  "rate_limiting_url": "text",
  "self_api_url": "text",
  "self_web_url": "text",
  "slug": "text",
  "tags": [
    "text"
  ],
  "technical_documentation_url": "text",
  "title": "My awesome API"
}

get

Paramètres de chemin

dataservicestringRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

access_typestring · enumOptionnelExample: openValeurs possibles:

access_type_reasonstringOptionnel

access_type_reason_categorystring · enumOptionnelExample: confidentiality_of_proceedings_of_public_authoritiesValeurs possibles:

acronymstring · max: 128Optionnel

archived_atstring · date-timeOptionnel

authorization_request_urlstringOptionnel

availabilitynumberOptionnelExample: 99.99

availability_urlstringOptionnel

base_api_urlstringOptionnel

business_documentation_urlstringOptionnel

created_atstring · date-timeLecture seuleRequis

datasetsobjectOptionnel

Visit this API link to see the list.

deleted_atstring · date-timeOptionnel

descriptionstring · markdownOptionnel

extrasobjectOptionnel

featuredbooleanLecture seuleOptionnel

formatstring · enumOptionnelExample: RESTValeurs possibles:

idstringLecture seuleRequis

licensestringOptionnel

The ID of the license

machine_documentation_urlstringOptionnel

Swagger link, OpenAPI format, WMS XML…

metadata_modified_atstring · date-timeLecture seuleRequis

metricsobjectLecture seuleOptionnel

privatebooleanOptionnel

Is the dataservice private to the owner or the organization

rate_limitingstringOptionnel

rate_limiting_urlstringOptionnel

self_api_urlstringLecture seuleOptionnel

Link to the API endpoint for this dataservice

self_web_urlstringLecture seuleOptionnel

Link to the udata web page for this dataservice

slugstring · max: 255Lecture seuleRequis

tagsstring[]Optionnel

technical_documentation_urlstringOptionnel

HTML version of a Swagger…

titlestringRequisExample: My awesome API

get/dataservices/{dataservice}/

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

200

Success

{
  "access_audiences": [
    {
      "condition": "yes",
      "role": "local_authority_and_administration"
    }
  ],
  "access_type": "open",
  "access_type_reason": "text",
  "access_type_reason_category": "confidentiality_of_proceedings_of_public_authorities",
  "acronym": "text",
  "archived_at": "2026-07-14T21:26:13.984Z",
  "authorization_request_url": "text",
  "availability": "99.99",
  "availability_url": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "base_api_url": "text",
  "business_documentation_url": "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",
        "permissions": {
          "delete": true,
          "edit": true,
          "harvest": true,
          "members": true,
          "private": true
        },
        "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": "contact"
    }
  ],
  "created_at": "2026-07-14T21:26:13.984Z",
  "datasets": {},
  "deleted_at": "2026-07-14T21:26:13.984Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "format": "REST",
  "harvest": {
    "archived_at": "2026-07-14T21:26:13.984Z",
    "archived_reason": "text",
    "backend": "text",
    "created_at": "2026-07-14T21:26:13.984Z",
    "domain": "text",
    "issued_at": "2026-07-14T21:26:13.984Z",
    "last_update": "2026-07-14T21:26:13.984Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "source_url": "text",
    "uri": "text"
  },
  "id": "text",
  "license": "text",
  "machine_documentation_url": "text",
  "metadata_modified_at": "2026-07-14T21:26:13.984Z",
  "metrics": {},
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "permissions": {
      "delete": true,
      "edit": true,
      "harvest": true,
      "members": true,
      "private": true
    },
    "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"
  },
  "permissions": {
    "delete": true,
    "edit": true
  },
  "private": true,
  "rate_limiting": "text",
  "rate_limiting_url": "text",
  "self_api_url": "text",
  "self_web_url": "text",
  "slug": "text",
  "tags": [
    "text"
  ],
  "technical_documentation_url": "text",
  "title": "My awesome API"
}

List all followers for a given object

get

Paramètres de chemin

idstringRequis

Paramètres de requête

pageintegerOptionnel

The page to fetch

Default: 1

page_sizeintegerOptionnel

The page size to fetch

Default: 20

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

next_pagestringOptionnel

The next page URL if exists

pageinteger · min: 1Requis

The current page

page_sizeintegerRequis

The page size used for pagination

previous_pagestringOptionnel

The previous page URL if exists

totalintegerRequis

The total paginated items

get/dataservices/{id}/followers/

GET /api/1/dataservices/{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": "2026-07-14T21:26:13.984Z"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

post

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

access_typestring · enumOptionnelExample: openValeurs possibles:

access_type_reasonstringOptionnel

access_type_reason_categorystring · enumOptionnelExample: confidentiality_of_proceedings_of_public_authoritiesValeurs possibles:

acronymstring · max: 128Optionnel

archived_atstring · date-timeOptionnel

authorization_request_urlstringOptionnel

availabilitynumberOptionnelExample: 99.99

availability_urlstringOptionnel

base_api_urlstringOptionnel

business_documentation_urlstringOptionnel

contact_pointsstring[]Optionnel

ID of the reference

datasetsstring[]Optionnel

ID of the reference

deleted_atstring · date-timeOptionnel

descriptionstring · markdownOptionnel

extrasobjectOptionnel

formatstring · enumOptionnelExample: RESTValeurs possibles:

licensestringOptionnel

The ID of the license

machine_documentation_urlstringOptionnel

Swagger link, OpenAPI format, WMS XML…

organizationstringOptionnel

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

ownerstringOptionnel

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

privatebooleanOptionnel

Is the dataservice private to the owner or the organization

rate_limitingstringOptionnel

rate_limiting_urlstringOptionnel

tagsstring[]Optionnel

technical_documentation_urlstringOptionnel

HTML version of a Swagger…

titlestringRequisExample: My awesome API

Réponses

201

Success

application/json

access_typestring · enumOptionnelExample: openValeurs possibles:

access_type_reasonstringOptionnel

access_type_reason_categorystring · enumOptionnelExample: confidentiality_of_proceedings_of_public_authoritiesValeurs possibles:

acronymstring · max: 128Optionnel

archived_atstring · date-timeOptionnel

authorization_request_urlstringOptionnel

availabilitynumberOptionnelExample: 99.99

availability_urlstringOptionnel

base_api_urlstringOptionnel

business_documentation_urlstringOptionnel

created_atstring · date-timeLecture seuleRequis

datasetsobjectOptionnel

Visit this API link to see the list.

deleted_atstring · date-timeOptionnel

descriptionstring · markdownOptionnel

extrasobjectOptionnel

featuredbooleanLecture seuleOptionnel

formatstring · enumOptionnelExample: RESTValeurs possibles:

idstringLecture seuleRequis

licensestringOptionnel

The ID of the license

machine_documentation_urlstringOptionnel

Swagger link, OpenAPI format, WMS XML…

metadata_modified_atstring · date-timeLecture seuleRequis

metricsobjectLecture seuleOptionnel

privatebooleanOptionnel

Is the dataservice private to the owner or the organization

rate_limitingstringOptionnel

rate_limiting_urlstringOptionnel

self_api_urlstringLecture seuleOptionnel

Link to the API endpoint for this dataservice

self_web_urlstringLecture seuleOptionnel

Link to the udata web page for this dataservice

slugstring · max: 255Lecture seuleRequis

tagsstring[]Optionnel

technical_documentation_urlstringOptionnel

HTML version of a Swagger…

titlestringRequisExample: My awesome API

400

Validation error

post/dataservices/

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

{
  "access_audiences": [
    {
      "condition": "yes",
      "role": "local_authority_and_administration"
    }
  ],
  "access_type": "open",
  "access_type_reason": "text",
  "access_type_reason_category": "confidentiality_of_proceedings_of_public_authorities",
  "acronym": "text",
  "archived_at": "2026-07-14T21:26:13.984Z",
  "authorization_request_url": "text",
  "availability": "99.99",
  "availability_url": "text",
  "base_api_url": "text",
  "business_documentation_url": "text",
  "contact_points": [
    "text"
  ],
  "datasets": [
    "text"
  ],
  "deleted_at": "2026-07-14T21:26:13.984Z",
  "description": "text",
  "extras": {},
  "format": "REST",
  "license": "text",
  "machine_documentation_url": "text",
  "organization": "text",
  "owner": "text",
  "private": true,
  "rate_limiting": "text",
  "rate_limiting_url": "text",
  "tags": [
    "text"
  ],
  "technical_documentation_url": "text",
  "title": "My awesome API"
}

{
  "access_audiences": [
    {
      "condition": "yes",
      "role": "local_authority_and_administration"
    }
  ],
  "access_type": "open",
  "access_type_reason": "text",
  "access_type_reason_category": "confidentiality_of_proceedings_of_public_authorities",
  "acronym": "text",
  "archived_at": "2026-07-14T21:26:13.984Z",
  "authorization_request_url": "text",
  "availability": "99.99",
  "availability_url": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "base_api_url": "text",
  "business_documentation_url": "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",
        "permissions": {
          "delete": true,
          "edit": true,
          "harvest": true,
          "members": true,
          "private": true
        },
        "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": "contact"
    }
  ],
  "created_at": "2026-07-14T21:26:13.984Z",
  "datasets": {},
  "deleted_at": "2026-07-14T21:26:13.984Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "format": "REST",
  "harvest": {
    "archived_at": "2026-07-14T21:26:13.984Z",
    "archived_reason": "text",
    "backend": "text",
    "created_at": "2026-07-14T21:26:13.984Z",
    "domain": "text",
    "issued_at": "2026-07-14T21:26:13.984Z",
    "last_update": "2026-07-14T21:26:13.984Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "source_url": "text",
    "uri": "text"
  },
  "id": "text",
  "license": "text",
  "machine_documentation_url": "text",
  "metadata_modified_at": "2026-07-14T21:26:13.984Z",
  "metrics": {},
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "permissions": {
      "delete": true,
      "edit": true,
      "harvest": true,
      "members": true,
      "private": true
    },
    "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"
  },
  "permissions": {
    "delete": true,
    "edit": true
  },
  "private": true,
  "rate_limiting": "text",
  "rate_limiting_url": "text",
  "self_api_url": "text",
  "self_web_url": "text",
  "slug": "text",
  "tags": [
    "text"
  ],
  "technical_documentation_url": "text",
  "title": "My awesome API"
}

delete

Paramètres de chemin

dataservicestringRequis

Paramètres de requête

send_legal_noticebooleanOptionnel

Send formal legal notice with appeal information to owner (admin only)

Default: false

Réponses

204

dataservice deleted

Aucun contenu

delete/dataservices/{dataservice}/

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

204

dataservice deleted

Aucun contenu

patch

Paramètres de chemin

dataservicestringRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

access_typestring · enumOptionnelExample: openValeurs possibles:

access_type_reasonstringOptionnel

access_type_reason_categorystring · enumOptionnelExample: confidentiality_of_proceedings_of_public_authoritiesValeurs possibles:

acronymstring · max: 128Optionnel

archived_atstring · date-timeOptionnel

authorization_request_urlstringOptionnel

availabilitynumberOptionnelExample: 99.99

availability_urlstringOptionnel

base_api_urlstringOptionnel

business_documentation_urlstringOptionnel

contact_pointsstring[]Optionnel

ID of the reference

datasetsstring[]Optionnel

ID of the reference

deleted_atstring · date-timeOptionnel

descriptionstring · markdownOptionnel

extrasobjectOptionnel

formatstring · enumOptionnelExample: RESTValeurs possibles:

licensestringOptionnel

The ID of the license

machine_documentation_urlstringOptionnel

Swagger link, OpenAPI format, WMS XML…

organizationstringOptionnel

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

ownerstringOptionnel

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

privatebooleanOptionnel

Is the dataservice private to the owner or the organization

rate_limitingstringOptionnel

rate_limiting_urlstringOptionnel

tagsstring[]Optionnel

technical_documentation_urlstringOptionnel

HTML version of a Swagger…

titlestringRequisExample: My awesome API

Réponses

200

Success

application/json

access_typestring · enumOptionnelExample: openValeurs possibles:

access_type_reasonstringOptionnel

access_type_reason_categorystring · enumOptionnelExample: confidentiality_of_proceedings_of_public_authoritiesValeurs possibles:

acronymstring · max: 128Optionnel

archived_atstring · date-timeOptionnel

authorization_request_urlstringOptionnel

availabilitynumberOptionnelExample: 99.99

availability_urlstringOptionnel

base_api_urlstringOptionnel

business_documentation_urlstringOptionnel

created_atstring · date-timeLecture seuleRequis

datasetsobjectOptionnel

Visit this API link to see the list.

deleted_atstring · date-timeOptionnel

descriptionstring · markdownOptionnel

extrasobjectOptionnel

featuredbooleanLecture seuleOptionnel

formatstring · enumOptionnelExample: RESTValeurs possibles:

idstringLecture seuleRequis

licensestringOptionnel

The ID of the license

machine_documentation_urlstringOptionnel

Swagger link, OpenAPI format, WMS XML…

metadata_modified_atstring · date-timeLecture seuleRequis

metricsobjectLecture seuleOptionnel

privatebooleanOptionnel

Is the dataservice private to the owner or the organization

rate_limitingstringOptionnel

rate_limiting_urlstringOptionnel

self_api_urlstringLecture seuleOptionnel

Link to the API endpoint for this dataservice

self_web_urlstringLecture seuleOptionnel

Link to the udata web page for this dataservice

slugstring · max: 255Lecture seuleRequis

tagsstring[]Optionnel

technical_documentation_urlstringOptionnel

HTML version of a Swagger…

titlestringRequisExample: My awesome API

400

Validation error

patch/dataservices/{dataservice}/

PATCH /api/1/dataservices/{dataservice}/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 787

{
  "access_audiences": [
    {
      "condition": "yes",
      "role": "local_authority_and_administration"
    }
  ],
  "access_type": "open",
  "access_type_reason": "text",
  "access_type_reason_category": "confidentiality_of_proceedings_of_public_authorities",
  "acronym": "text",
  "archived_at": "2026-07-14T21:26:13.984Z",
  "authorization_request_url": "text",
  "availability": "99.99",
  "availability_url": "text",
  "base_api_url": "text",
  "business_documentation_url": "text",
  "contact_points": [
    "text"
  ],
  "datasets": [
    "text"
  ],
  "deleted_at": "2026-07-14T21:26:13.984Z",
  "description": "text",
  "extras": {},
  "format": "REST",
  "license": "text",
  "machine_documentation_url": "text",
  "organization": "text",
  "owner": "text",
  "private": true,
  "rate_limiting": "text",
  "rate_limiting_url": "text",
  "tags": [
    "text"
  ],
  "technical_documentation_url": "text",
  "title": "My awesome API"
}

{
  "access_audiences": [
    {
      "condition": "yes",
      "role": "local_authority_and_administration"
    }
  ],
  "access_type": "open",
  "access_type_reason": "text",
  "access_type_reason_category": "confidentiality_of_proceedings_of_public_authorities",
  "acronym": "text",
  "archived_at": "2026-07-14T21:26:13.984Z",
  "authorization_request_url": "text",
  "availability": "99.99",
  "availability_url": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "base_api_url": "text",
  "business_documentation_url": "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",
        "permissions": {
          "delete": true,
          "edit": true,
          "harvest": true,
          "members": true,
          "private": true
        },
        "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": "contact"
    }
  ],
  "created_at": "2026-07-14T21:26:13.984Z",
  "datasets": {},
  "deleted_at": "2026-07-14T21:26:13.984Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "format": "REST",
  "harvest": {
    "archived_at": "2026-07-14T21:26:13.984Z",
    "archived_reason": "text",
    "backend": "text",
    "created_at": "2026-07-14T21:26:13.984Z",
    "domain": "text",
    "issued_at": "2026-07-14T21:26:13.984Z",
    "last_update": "2026-07-14T21:26:13.984Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "source_url": "text",
    "uri": "text"
  },
  "id": "text",
  "license": "text",
  "machine_documentation_url": "text",
  "metadata_modified_at": "2026-07-14T21:26:13.984Z",
  "metrics": {},
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "permissions": {
      "delete": true,
      "edit": true,
      "harvest": true,
      "members": true,
      "private": true
    },
    "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"
  },
  "permissions": {
    "delete": true,
    "edit": true
  },
  "private": true,
  "rate_limiting": "text",
  "rate_limiting_url": "text",
  "self_api_url": "text",
  "self_web_url": "text",
  "slug": "text",
  "tags": [
    "text"
  ],
  "technical_documentation_url": "text",
  "title": "My awesome API"
}

delete

Paramètres de chemin

dataservicestringRequis

The dataservice ID or slug

datasetstringRequis

Réponses

404

Dataservice not found

Aucun contenu

delete/dataservices/{dataservice}/datasets/{dataset}/

DELETE /api/1/dataservices/{dataservice}/datasets/{dataset}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

404

Dataservice not found

Aucun contenu

Follow an object given its ID

post

Returns the number of followers left after the operation

Paramètres de chemin

idstringRequis

Réponses

200

Success

Aucun contenu

post/dataservices/{id}/followers/

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

200

Success

Aucun contenu

Unmark a dataservice as featured

delete

Paramètres de chemin

dataservicestringRequis

The dataservice ID or slug

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

access_typestring · enumOptionnelExample: openValeurs possibles:

access_type_reasonstringOptionnel

access_type_reason_categorystring · enumOptionnelExample: confidentiality_of_proceedings_of_public_authoritiesValeurs possibles:

acronymstring · max: 128Optionnel

archived_atstring · date-timeOptionnel

authorization_request_urlstringOptionnel

availabilitynumberOptionnelExample: 99.99

availability_urlstringOptionnel

base_api_urlstringOptionnel

business_documentation_urlstringOptionnel

created_atstring · date-timeLecture seuleRequis

datasetsobjectOptionnel

Visit this API link to see the list.

deleted_atstring · date-timeOptionnel

descriptionstring · markdownOptionnel

extrasobjectOptionnel

featuredbooleanLecture seuleOptionnel

formatstring · enumOptionnelExample: RESTValeurs possibles:

idstringLecture seuleRequis

licensestringOptionnel

The ID of the license

machine_documentation_urlstringOptionnel

Swagger link, OpenAPI format, WMS XML…

metadata_modified_atstring · date-timeLecture seuleRequis

metricsobjectLecture seuleOptionnel

privatebooleanOptionnel

Is the dataservice private to the owner or the organization

rate_limitingstringOptionnel

rate_limiting_urlstringOptionnel

self_api_urlstringLecture seuleOptionnel

Link to the API endpoint for this dataservice

self_web_urlstringLecture seuleOptionnel

Link to the udata web page for this dataservice

slugstring · max: 255Lecture seuleRequis

tagsstring[]Optionnel

technical_documentation_urlstringOptionnel

HTML version of a Swagger…

titlestringRequisExample: My awesome API

delete/dataservices/{dataservice}/featured/

DELETE /api/1/dataservices/{dataservice}/featured/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "access_audiences": [
    {
      "condition": "yes",
      "role": "local_authority_and_administration"
    }
  ],
  "access_type": "open",
  "access_type_reason": "text",
  "access_type_reason_category": "confidentiality_of_proceedings_of_public_authorities",
  "acronym": "text",
  "archived_at": "2026-07-14T21:26:13.984Z",
  "authorization_request_url": "text",
  "availability": "99.99",
  "availability_url": "text",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "base_api_url": "text",
  "business_documentation_url": "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",
        "permissions": {
          "delete": true,
          "edit": true,
          "harvest": true,
          "members": true,
          "private": true
        },
        "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": "contact"
    }
  ],
  "created_at": "2026-07-14T21:26:13.984Z",
  "datasets": {},
  "deleted_at": "2026-07-14T21:26:13.984Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "format": "REST",
  "harvest": {
    "archived_at": "2026-07-14T21:26:13.984Z",
    "archived_reason": "text",
    "backend": "text",
    "created_at": "2026-07-14T21:26:13.984Z",
    "domain": "text",
    "issued_at": "2026-07-14T21:26:13.984Z",
    "last_update": "2026-07-14T21:26:13.984Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "source_url": "text",
    "uri": "text"
  },
  "id": "text",
  "license": "text",
  "machine_documentation_url": "text",
  "metadata_modified_at": "2026-07-14T21:26:13.984Z",
  "metrics": {},
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "permissions": {
      "delete": true,
      "edit": true,
      "harvest": true,
      "members": true,
      "private": true
    },
    "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"
  },
  "permissions": {
    "delete": true,
    "edit": true
  },
  "private": true,
  "rate_limiting": "text",
  "rate_limiting_url": "text",
  "self_api_url": "text",
  "self_web_url": "text",
  "slug": "text",
  "tags": [
    "text"
  ],
  "technical_documentation_url": "text",
  "title": "My awesome API"
}

Unfollow an object given its ID

delete

Returns the number of followers left after the operation

Paramètres de chemin

idstringRequis

Réponses

200

Success

Aucun contenu

delete/dataservices/{id}/followers/

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

200

Success

Aucun contenu

Précédentharvest SuivantTélécharger le catalogue de données de data.gouv.fr

Mis à jour il y a 2 mois

Ce contenu vous a-t-il été utile ?