Government — entry 051 of 90
Open Government, France
Data.gouv.fr is France's national open-data catalogue, run by the state's Etalab mission on its own open-source uData platform rather than CKAN. Its REST API at `/api/1/` lets anyone browse and search datasets, organizations, and reuses as JSON with no key required — a live unauthenticated call to `/api/1/datasets/` returns full results; a key is only needed to authenticate write operations like publishing or editing a dataset through a personal account. The live API also sends a wildcard `Access-Control-Allow-Origin` header, so browser-side apps can query it cross-origin without a proxy.
Data.gouv.fr is France's national open-data catalogue, run by the state's Etalab mission on its own uData platform rather than CKAN. A live GET this run against /datasets/?page_size=1 returned a genuine 200, 19,796 B JSON envelope (content-type: application/json) reporting total: 73772 datasets, and an explicit Origin: https://example.com probe confirmed a wildcard access-control-allow-origin: * header — only echoed when a request actually carries an Origin header, which a plain curl doesn't send, so a bare probe with no Origin gets no CORS header at all. That's standard CORS behavior, not a regression, and it still matches the stored cors: yes. No API key is required to read; a key only gates write operations like publishing or editing a dataset through a personal account, as the entry's own summary already says.
GreatAPIs Score
Auth quickstart
- No API key, signup, or credit card required for reading — a live GET this run against
/datasets/?page_size=1returned a full result set on the first anonymous try.
Your key is stored only in this browser (localStorage) and sent directly to the API — never to greatapis.
Endpoints
site14
Site global namespace
GET/activity/Fetch site activity, optionally filtered by user or org
| Name | In | Required | Type |
|---|---|---|---|
page | query | no | integer |
page_size | query | no | integer |
user | query | no | string |
organization | query | no | string |
related_to | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | ActivityPage |
GET/site/Site-wide variables
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Site%20%28read%29 |
PATCH/site/
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — Site%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Site%20%28read%29 |
GET/site/catalogRoot RDF endpoint with content negociation handling
| Name | In | Required | Type |
|---|---|---|---|
q | query | no | string |
sort | query | no | string |
page | query | no | integer |
tag | query | no | array |
license | query | no | string |
featured | query | no | boolean |
geozone | query | no | string |
granularity | query | no | string |
temporal_coverage | query | no | string |
access_type | query | no | string |
organization | query | no | string |
badge | query | no | string |
organization_badge | query | no | string |
owner | query | no | string |
followed_by | query | no | string |
format | query | no | string |
schema | query | no | string |
schema_version | query | no | string |
topic | query | no | string |
credit | query | no | string |
dataservice | query | no | string |
reuse | query | no | string |
archived | query | no | boolean |
deleted | query | no | boolean |
private | query | no | boolean |
page_size | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/site/catalog.{_format}Return the RDF catalog in the requested format
| Name | In | Required | Type |
|---|---|---|---|
_format | path | yes | string |
q | query | no | string |
sort | query | no | string |
page | query | no | integer |
tag | query | no | array |
license | query | no | string |
featured | query | no | boolean |
geozone | query | no | string |
granularity | query | no | string |
temporal_coverage | query | no | string |
access_type | query | no | string |
organization | query | no | string |
badge | query | no | string |
organization_badge | query | no | string |
owner | query | no | string |
followed_by | query | no | string |
format | query | no | string |
schema | query | no | string |
schema_version | query | no | string |
topic | query | no | string |
credit | query | no | string |
dataservice | query | no | string |
reuse | query | no | string |
archived | query | no | boolean |
deleted | query | no | boolean |
private | query | no | boolean |
page_size | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/site/context.jsonld
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/site/data.{_format}Root RDF endpoint with content negociation handling
| Name | In | Required | Type |
|---|---|---|---|
_format | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/site/dataservices.csv
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/site/datasets.csv
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/site/harvests.csv
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/site/organizations.csv
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/site/resources.csv
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/site/reuses.csv
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/site/tags.csv
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
proconnect4
Proconnect related operations
GET/proconnect/auth
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/proconnect/login/
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/proconnect/logout
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/proconnect/logout_oauth
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
datasets39
Dataset related operations
GET/datasets/List or search all datasets
| Name | In | Required | Type |
|---|---|---|---|
q | query | no | string |
sort | query | no | string |
page | query | no | integer |
page_size | query | no | integer |
tag | query | no | array |
license | query | no | string |
featured | query | no | boolean |
geozone | query | no | string |
granularity | query | no | string |
temporal_coverage | query | no | string |
access_type | query | no | string |
organization | query | no | string |
badge | query | no | string |
organization_badge | query | no | string |
owner | query | no | string |
followed_by | query | no | string |
format | query | no | string |
schema | query | no | string |
schema_version | query | no | string |
topic | query | no | string |
credit | query | no | string |
dataservice | query | no | string |
reuse | query | no | string |
archived | query | no | boolean |
deleted | query | no | boolean |
private | query | no | boolean |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | DatasetPage |
POST/datasets/Create a new dataset
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — Dataset (required)
| Status | Description | Schema |
|---|---|---|
201 | Success | Dataset |
400 | Validation error | — |
GET/datasets/badges/List all available dataset badges and their labels
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/datasets/community_resources/List all community resources
| Name | In | Required | Type |
|---|---|---|---|
sort | query | no | string |
page | query | no | integer |
page_size | query | no | integer |
organization | query | no | string |
dataset | query | no | string |
owner | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | CommunityResourcePage |
POST/datasets/community_resources/Create a new community resource
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — CommunityResource (required)
| Status | Description | Schema |
|---|---|---|
201 | Success | CommunityResource |
400 | Validation error | — |
GET/datasets/community_resources/{community}/Retrieve a community resource given its identifier
| Name | In | Required | Type |
|---|---|---|---|
community | path | yes | string |
dataset | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | CommunityResource |
PUT/datasets/community_resources/{community}/Update a given community resource
| Name | In | Required | Type |
|---|---|---|---|
community | path | yes | string |
dataset | query | no | string |
X-Fields | header | no | string |
application/json — CommunityResource (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | CommunityResource |
400 | Validation error | — |
DELETE/datasets/community_resources/{community}/Delete a given community resource
| Name | In | Required | Type |
|---|---|---|---|
community | path | yes | string |
dataset | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
POST/datasets/community_resources/{community}/upload/Update the file related to a given community resource
| Name | In | Required | Type |
|---|---|---|---|
community | path | yes | string |
dataset | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | UploadedCommunityResource |
400 | Upload error | — |
415 | Incorrect file content type | — |
GET/datasets/extensions/List all allowed resources extensions
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/datasets/frequencies/List all available frequencies
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/datasets/licenses/List all available licenses
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/datasets/r/{id}Redirect to the latest version of a resource given its identifier
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
dataset | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/datasets/recent.atom
| Name | In | Required | Type |
|---|---|---|---|
q | query | no | string |
sort | query | no | string |
page | query | no | integer |
page_size | query | no | integer |
tag | query | no | array |
license | query | no | string |
featured | query | no | boolean |
geozone | query | no | string |
granularity | query | no | string |
temporal_coverage | query | no | string |
access_type | query | no | string |
organization | query | no | string |
badge | query | no | string |
organization_badge | query | no | string |
owner | query | no | string |
followed_by | query | no | string |
format | query | no | string |
schema | query | no | string |
schema_version | query | no | string |
topic | query | no | string |
credit | query | no | string |
dataservice | query | no | string |
reuse | query | no | string |
archived | query | no | boolean |
deleted | query | no | boolean |
private | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/datasets/resource_types/List all resource types
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/datasets/schemas/List all available schemas
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/datasets/suggest/Datasets suggest endpoint using mongoDB contains
| Name | In | Required | Type |
|---|---|---|---|
q | query | yes | string |
size | query | no | integer |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | DatasetSuggestion |
GET/datasets/suggest/formats/Suggest file formats
| Name | In | Required | Type |
|---|---|---|---|
q | query | yes | string |
size | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/datasets/suggest/mime/Suggest mime types
| Name | In | Required | Type |
|---|---|---|---|
q | query | yes | string |
size | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/datasets/{dataset}/Get a dataset given its identifier
| Name | In | Required | Type |
|---|---|---|---|
dataset | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Dataset |
404 | Dataset not found | — |
410 | Dataset has been deleted | — |
PUT/datasets/{dataset}/Update a dataset given its identifier
| Name | In | Required | Type |
|---|---|---|---|
dataset | path | yes | string |
X-Fields | header | no | string |
application/json — Dataset (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Dataset |
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. | — |
404 | Dataset not found | — |
410 | Dataset has been deleted | — |
DELETE/datasets/{dataset}/Delete a dataset given its identifier
| Name | In | Required | Type |
|---|---|---|---|
dataset | path | yes | string |
send_legal_notice | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
204 | Dataset deleted | — |
404 | Dataset not found | — |
410 | Dataset has been deleted | — |
POST/datasets/{dataset}/badges/Create a new badge for a given dataset
| Name | In | Required | Type |
|---|---|---|---|
dataset | path | yes | string |
X-Fields | header | no | string |
application/json — Badge%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Badge%20%28read%29 |
DELETE/datasets/{dataset}/badges/{badge_kind}/Delete a badge for a given dataset
| Name | In | Required | Type |
|---|---|---|---|
badge_kind | path | yes | string |
dataset | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
POST/datasets/{dataset}/featured/Mark the dataset as featured
| Name | In | Required | Type |
|---|---|---|---|
dataset | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Dataset |
DELETE/datasets/{dataset}/featured/Unmark the dataset as featured
| Name | In | Required | Type |
|---|---|---|---|
dataset | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Dataset |
GET/datasets/{dataset}/rdf
| Name | In | Required | Type |
|---|---|---|---|
dataset | path | yes | string |
| Status | Description | Schema |
|---|---|---|
404 | Dataset not found | — |
410 | Dataset has been deleted | — |
GET/datasets/{dataset}/rdf.{_format}
| Name | In | Required | Type |
|---|---|---|---|
dataset | path | yes | string |
_format | path | yes | string |
| Status | Description | Schema |
|---|---|---|
404 | Dataset not found | — |
410 | Dataset has been deleted | — |
POST/datasets/{dataset}/resources/Create a new resource for a given dataset
| Name | In | Required | Type |
|---|---|---|---|
dataset | path | yes | string |
X-Fields | header | no | string |
application/json — Resource (required)
| Status | Description | Schema |
|---|---|---|
201 | Success | Resource |
400 | Validation error | — |
PUT/datasets/{dataset}/resources/Reorder resources
| Name | In | Required | Type |
|---|---|---|---|
dataset | path | yes | string |
X-Fields | header | no | string |
application/json (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
400 | Validation error | — |
GET/datasets/{dataset}/resources/{rid}/Get a resource given its identifier
| Name | In | Required | Type |
|---|---|---|---|
rid | path | yes | string |
dataset | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Resource |
PUT/datasets/{dataset}/resources/{rid}/Update a given resource on a given dataset
| Name | In | Required | Type |
|---|---|---|---|
rid | path | yes | string |
dataset | path | yes | string |
X-Fields | header | no | string |
application/json — Resource (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Resource |
400 | Validation error | — |
DELETE/datasets/{dataset}/resources/{rid}/Delete a given resource on a given dataset
| Name | In | Required | Type |
|---|---|---|---|
rid | path | yes | string |
dataset | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
POST/datasets/{dataset}/resources/{rid}/upload/Upload a file related to a given resource on a given dataset
| Name | In | Required | Type |
|---|---|---|---|
rid | path | yes | string |
dataset | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | UploadedResource |
400 | Upload error | — |
415 | Incorrect file content type | — |
POST/datasets/{dataset}/upload/Upload a file for a new dataset resource
| Name | In | Required | Type |
|---|---|---|---|
dataset | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
201 | Success | UploadedResource |
400 | Upload error | — |
415 | Incorrect file content type | — |
POST/datasets/{dataset}/upload/community/Upload a new community resource
| Name | In | Required | Type |
|---|---|---|---|
dataset | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
201 | Success | UploadedCommunityResource |
400 | Upload error | — |
415 | Incorrect file content type | — |
GET/datasets/{id}/followers/List all followers for a given object
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
page | query | no | integer |
page_size | query | no | integer |
user | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | FollowPage |
POST/datasets/{id}/followers/Follow an object given its ID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
DELETE/datasets/{id}/followers/Unfollow an object given its ID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
organizations36
Organization related operations
GET/organizations/List or search all organizations
| Name | In | Required | Type |
|---|---|---|---|
q | query | no | string |
sort | query | no | string |
page | query | no | integer |
page_size | query | no | integer |
badge | query | no | string |
name | query | no | string |
business_number_id | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | OrganizationPage |
POST/organizations/Create a new organization
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — Organization%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
201 | Success | Organization%20%28read%29 |
400 | Validation error | — |
GET/organizations/badges/List all available organization badges and their labels
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/organizations/roles/List all possible organization roles
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/organizations/suggest/Organizations suggest endpoint using mongoDB contains
| Name | In | Required | Type |
|---|---|---|---|
q | query | yes | string |
size | query | no | integer |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/organizations/{id}/followers/List all followers for a given object
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
page | query | no | integer |
page_size | query | no | integer |
user | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | FollowPage |
POST/organizations/{id}/followers/Follow an object given its ID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
DELETE/organizations/{id}/followers/Unfollow an object given its ID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/organizations/{org}/Get a organization given its identifier
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Organization%20%28read%29 |
404 | Organization not found | — |
410 | Organization has been deleted | — |
PUT/organizations/{org}/Update a organization given its identifier
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
X-Fields | header | no | string |
application/json — Organization%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Organization%20%28read%29 |
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 | — | — |
404 | Organization not found | — |
410 | Organization has been deleted | — |
DELETE/organizations/{org}/Delete a organization given its identifier
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
send_legal_notice | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
204 | Organization deleted | — |
404 | Organization not found | — |
410 | Organization has been deleted | — |
GET/organizations/{org}/assignments/List assignments for this organization
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
POST/organizations/{org}/badges/Create a new badge for a given organization
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
X-Fields | header | no | string |
application/json — Badge%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Badge%20%28read%29 |
DELETE/organizations/{org}/badges/{badge_kind}/Delete a badge for a given organization
| Name | In | Required | Type |
|---|---|---|---|
badge_kind | path | yes | string |
org | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/organizations/{org}/catalog
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
| Status | Description | Schema |
|---|---|---|
404 | Organization not found | — |
410 | Organization has been deleted | — |
GET/organizations/{org}/catalog.{_format}
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
_format | path | yes | string |
q | query | no | string |
sort | query | no | string |
page | query | no | integer |
tag | query | no | array |
license | query | no | string |
featured | query | no | boolean |
geozone | query | no | string |
granularity | query | no | string |
temporal_coverage | query | no | string |
access_type | query | no | string |
organization | query | no | string |
badge | query | no | string |
organization_badge | query | no | string |
owner | query | no | string |
followed_by | query | no | string |
format | query | no | string |
schema | query | no | string |
schema_version | query | no | string |
topic | query | no | string |
credit | query | no | string |
dataservice | query | no | string |
reuse | query | no | string |
archived | query | no | boolean |
deleted | query | no | boolean |
private | query | no | boolean |
page_size | query | no | integer |
| Status | Description | Schema |
|---|---|---|
404 | Organization not found | — |
410 | Organization has been deleted | — |
GET/organizations/{org}/contacts/List all organization contact points
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | ContactPointPage |
GET/organizations/{org}/contacts/suggest/Contact points suggest endpoint using mongoDB contains
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
q | query | yes | string |
size | query | no | integer |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/organizations/{org}/dataservices.csv
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
| Status | Description | Schema |
|---|---|---|
404 | Organization not found | — |
410 | Organization has been deleted | — |
GET/organizations/{org}/datasets-resources.csv
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
| Status | Description | Schema |
|---|---|---|
404 | Organization not found | — |
410 | Organization has been deleted | — |
GET/organizations/{org}/datasets.csv
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
| Status | Description | Schema |
|---|---|---|
404 | Organization not found | — |
410 | Organization has been deleted | — |
GET/organizations/{org}/datasets/List organization datasets (including private ones when member)
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
q | query | no | string |
sort | query | no | string |
page | query | no | integer |
page_size | query | no | integer |
tag | query | no | array |
license | query | no | string |
featured | query | no | boolean |
geozone | query | no | string |
granularity | query | no | string |
temporal_coverage | query | no | string |
access_type | query | no | string |
organization | query | no | string |
badge | query | no | string |
organization_badge | query | no | string |
owner | query | no | string |
followed_by | query | no | string |
format | query | no | string |
schema | query | no | string |
schema_version | query | no | string |
topic | query | no | string |
credit | query | no | string |
dataservice | query | no | string |
reuse | query | no | string |
archived | query | no | boolean |
deleted | query | no | boolean |
private | query | no | boolean |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | DatasetPage |
GET/organizations/{org}/discussions.csv
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
| Status | Description | Schema |
|---|---|---|
404 | Organization not found | — |
410 | Organization has been deleted | — |
GET/organizations/{org}/discussions/List organization discussions
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
POST/organizations/{org}/logo/Upload a new logo
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | UploadedImage |
PUT/organizations/{org}/logo/Set the logo BBox
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | UploadedImage |
POST/organizations/{org}/member/Invite a user or email to join the organization
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
X-Fields | header | no | string |
application/json — MembershipInvite (required)
| Status | Description | Schema |
|---|---|---|
201 | Success | MembershipRequest |
400 | Bad Request | — |
403 | Not Authorized | — |
PUT/organizations/{org}/member/{user}/Update member status into a given organization
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
user | path | yes | string |
X-Fields | header | no | string |
application/json — Member%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Member%20%28read%29 |
403 | Not Authorized | — |
DELETE/organizations/{org}/member/{user}/Delete member from an organization
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
user | path | yes | string |
| Status | Description | Schema |
|---|---|---|
403 | Not Authorized | — |
PUT/organizations/{org}/member/{user}/assignments/Sync assignments for a partial_editor member
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
user | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
403 | Not Authorized | — |
GET/organizations/{org}/membership/List membership requests for a given organization
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
status | query | no | string |
user | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
403 | Not Authorized | — |
POST/organizations/{org}/membership/Apply for membership to a given organization
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
X-Fields | header | no | string |
application/json — MembershipRequest%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | MembershipRequest |
POST/organizations/{org}/membership/{id}/accept/Accept user membership to a given organization
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
org | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Member%20%28read%29 |
POST/organizations/{org}/membership/{id}/cancel/Cancel a pending invitation for a given organization
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
org | path | yes | string |
| Status | Description | Schema |
|---|---|---|
400 | Membership request is not pending | — |
POST/organizations/{org}/membership/{id}/refuse/Refuse user membership to a given organization
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
org | path | yes | string |
application/json — RefuseMembership (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/organizations/{org}/reuses/List organization reuses (including private ones when member)
| Name | In | Required | Type |
|---|---|---|---|
org | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
reuses20
Reuse related operations
GET/reuses/
| Name | In | Required | Type |
|---|---|---|---|
page | query | no | integer |
page_size | query | no | integer |
sort | query | no | string |
q | query | no | string |
owner | query | no | string |
organization | query | no | string |
organization_badge | query | no | string |
type | query | no | string |
dataset | query | no | string |
dataservice | query | no | string |
tag | query | no | array |
topic | query | no | string |
private | query | no | boolean |
featured | query | no | boolean |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | ReusePage |
POST/reuses/
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — Reuse%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
201 | Success | Reuse%20%28read%29 |
400 | Validation error | — |
GET/reuses/badges/List all available reuse badges and their labels
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/reuses/recent.atom
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/reuses/suggest/Reuses suggest endpoint using mongoDB contains
| Name | In | Required | Type |
|---|---|---|---|
q | query | yes | string |
size | query | no | integer |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/reuses/topics/List all reuse topics
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/reuses/types/List all reuse types
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/reuses/{id}/followers/List all followers for a given object
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
page | query | no | integer |
page_size | query | no | integer |
user | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | FollowPage |
POST/reuses/{id}/followers/Follow an object given its ID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
DELETE/reuses/{id}/followers/Unfollow an object given its ID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/reuses/{reuse}/Fetch a given reuse
| Name | In | Required | Type |
|---|---|---|---|
reuse | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Reuse%20%28read%29 |
404 | Reuse not found | — |
410 | Reuse has been deleted | — |
PUT/reuses/{reuse}/Update a given reuse
| Name | In | Required | Type |
|---|---|---|---|
reuse | path | yes | string |
X-Fields | header | no | string |
application/json — Reuse%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Reuse%20%28read%29 |
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. | — |
404 | Reuse not found | — |
410 | Reuse has been deleted | — |
DELETE/reuses/{reuse}/Delete a given reuse
| Name | In | Required | Type |
|---|---|---|---|
reuse | path | yes | string |
send_legal_notice | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
204 | Reuse deleted | — |
404 | Reuse not found | — |
410 | Reuse has been deleted | — |
POST/reuses/{reuse}/badges/Create a new badge for a given reuse
| Name | In | Required | Type |
|---|---|---|---|
reuse | path | yes | string |
X-Fields | header | no | string |
application/json — Badge%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Badge%20%28read%29 |
DELETE/reuses/{reuse}/badges/{badge_kind}/Delete a badge for a given reuse
| Name | In | Required | Type |
|---|---|---|---|
badge_kind | path | yes | string |
reuse | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
POST/reuses/{reuse}/dataservices/Add a dataservice to a given reuse
| Name | In | Required | Type |
|---|---|---|---|
reuse | path | yes | string |
X-Fields | header | no | string |
application/json — DataserviceReference (required)
| Status | Description | Schema |
|---|---|---|
200 | The dataservice is already present | Reuse%20%28read%29 |
201 | Success | Reuse%20%28read%29 |
403 | Not allowed to modify this reuse | — |
POST/reuses/{reuse}/datasets/Add a dataset to a given reuse
| Name | In | Required | Type |
|---|---|---|---|
reuse | path | yes | string |
X-Fields | header | no | string |
application/json — DatasetReference (required)
| Status | Description | Schema |
|---|---|---|
200 | The dataset is already present | Reuse%20%28read%29 |
201 | Success | Reuse%20%28read%29 |
403 | Not allowed to modify this reuse | — |
POST/reuses/{reuse}/featured/Mark a reuse as featured
| Name | In | Required | Type |
|---|---|---|---|
reuse | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Reuse%20%28read%29 |
DELETE/reuses/{reuse}/featured/Unmark a reuse as featured
| Name | In | Required | Type |
|---|---|---|---|
reuse | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Reuse%20%28read%29 |
POST/reuses/{reuse}/image/Upload a new reuse image
| Name | In | Required | Type |
|---|---|---|---|
reuse | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | UploadedImage |
access_type1
Access type related operations
GET/access_type/reason_categories/List all limitation reason categories
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
spatial7
Spatial references
GET/spatial/coverage/{level}/List each zone for a given level with their datasets count
| Name | In | Required | Type |
|---|---|---|---|
level | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/spatial/granularities/List all known spatial granularities
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/spatial/levels/List all known levels
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/spatial/zone/{id}/Fetch a zone
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/spatial/zone/{id}/datasets/Fetch datasets for a given zone
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
dynamic | query | no | boolean |
size | query | no | integer |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | DatasetReference |
GET/spatial/zones/suggest/Geospatial zones suggest endpoint using mongoDB contains
| Name | In | Required | Type |
|---|---|---|---|
q | query | yes | string |
size | query | no | integer |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/spatial/zones/{ids}/Fetch a zone list as GeoJSON
| Name | In | Required | Type |
|---|---|---|---|
ids | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | GeoJSONFeatureCollection |
users13
User related operations
GET/users/List all users
| Name | In | Required | Type |
|---|---|---|---|
q | query | no | string |
sort | query | no | string |
page | query | no | integer |
page_size | query | no | integer |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | UserPage |
POST/users/Create a new user
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — User%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
201 | Success | User%20%28read%29 |
400 | Validation error | — |
GET/users/roles/List all possible user roles
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/users/suggest/Suggest users
| Name | In | Required | Type |
|---|---|---|---|
q | query | yes | string |
size | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/users/{id}/followers/List all followers for a given object
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
page | query | no | integer |
page_size | query | no | integer |
user | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | FollowPage |
POST/users/{id}/followers/Follow a user given its ID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
403 | When trying to follow yourself | — |
DELETE/users/{id}/followers/Unfollow an object given its ID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/users/{user}/Get a user given its identifier
| Name | In | Required | Type |
|---|---|---|---|
user | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | User%20%28read%29 |
404 | User not found | — |
410 | User is not active or has been deleted | — |
PUT/users/{user}/Update a user given its identifier
| Name | In | Required | Type |
|---|---|---|---|
user | path | yes | string |
X-Fields | header | no | string |
application/json — User%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | User%20%28read%29 |
400 | Validation error | — |
404 | User not found | — |
410 | User is not active or has been deleted | — |
DELETE/users/{user}/Delete a user given its identifier
| Name | In | Required | Type |
|---|---|---|---|
user | path | yes | string |
send_legal_notice | query | no | boolean |
no_mail | query | no | boolean |
delete_comments | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
204 | Object deleted | — |
403 | When trying to delete yourself | — |
404 | User not found | — |
410 | User is not active or has been deleted | — |
POST/users/{user}/avatar/Upload a new avatar for a given user
| Name | In | Required | Type |
|---|---|---|---|
user | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | UploadedImage |
GET/users/{user}/contacts/List all user contact points
| Name | In | Required | Type |
|---|---|---|---|
user | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | ContactPointPage |
POST/users/{user}/rotate_password/Force a password rotation on the user's next login and reset their current sessions
| Name | In | Required | Type |
|---|---|---|---|
user | path | yes | string |
| Status | Description | Schema |
|---|---|---|
204 | Password rotation requested | — |
404 | User not found | — |
me17
Connected user related operations
GET/me/Fetch the current user (me) identity
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | User%20%28read%29 |
PUT/me/Update my profile
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — User%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | User%20%28read%29 |
400 | Validation error | — |
DELETE/me/Delete my profile
| Status | Description | Schema |
|---|---|---|
204 | Object deleted | — |
GET/me/api_tokens/List all my active API tokens
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
POST/me/api_tokens/Create a new API token
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — ApiToken%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
201 | Success | ApiTokenCreated |
DELETE/me/api_tokens/{api_token}/Revoke an API token
| Name | In | Required | Type |
|---|---|---|---|
api_token | path | yes | string |
| Status | Description | Schema |
|---|---|---|
204 | Token revoked | — |
404 | Token not found | — |
410 | Token already revoked | — |
POST/me/avatar/Upload a new avatar
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | UploadedImage |
GET/me/datasets/List all my datasets (including private ones)
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/me/metrics/Fetch the current user (me) metrics
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/me/org_community_resources/List all community resources related to me and my organizations
| Name | In | Required | Type |
|---|---|---|---|
q | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/me/org_datasets/List all datasets related to me and my organizations
| Name | In | Required | Type |
|---|---|---|---|
q | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/me/org_discussions/List all discussions related to my organizations
| Name | In | Required | Type |
|---|---|---|---|
q | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/me/org_invitations/List pending organization invitations for current user
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
POST/me/org_invitations/{id}/accept/Accept an organization invitation
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Invitation accepted | — |
400 | Invitation is not pending | — |
404 | Invitation not found | — |
POST/me/org_invitations/{id}/refuse/Refuse an organization invitation
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Invitation refused | — |
400 | Invitation is not pending | — |
404 | Invitation not found | — |
GET/me/org_reuses/List all reuses related to me and my organizations
| Name | In | Required | Type |
|---|---|---|---|
q | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/me/reuses/List all my reuses (including private ones)
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
dataservices15
Dataservices related operations (beta)
GET/dataservices/List or search all dataservices
| Name | In | Required | Type |
|---|---|---|---|
page | query | no | integer |
page_size | query | no | integer |
sort | query | no | string |
q | query | no | string |
topic | query | no | string |
reuse | query | no | string |
owner | query | no | string |
organization | query | no | string |
organization_badge | query | no | string |
access_type | query | no | string |
tag | query | no | array |
featured | query | no | boolean |
contact_point | query | no | string |
dataset | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | DataservicePage |
POST/dataservices/
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — Dataservice%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
201 | Success | Dataservice%20%28read%29 |
400 | Validation error | — |
GET/dataservices/recent.atom
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/dataservices/{dataservice}/
| Name | In | Required | Type |
|---|---|---|---|
dataservice | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Dataservice%20%28read%29 |
PATCH/dataservices/{dataservice}/
| Name | In | Required | Type |
|---|---|---|---|
dataservice | path | yes | string |
X-Fields | header | no | string |
application/json — Dataservice%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Dataservice%20%28read%29 |
400 | Validation error | — |
DELETE/dataservices/{dataservice}/
| Name | In | Required | Type |
|---|---|---|---|
dataservice | path | yes | string |
send_legal_notice | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
204 | dataservice deleted | — |
POST/dataservices/{dataservice}/datasets/
| Name | In | Required | Type |
|---|---|---|---|
dataservice | path | yes | string |
X-Fields | header | no | string |
application/json (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Dataservice%20%28read%29 |
400 | Malformed object id(s) in request | — |
403 | Forbidden | — |
404 | Dataservice not found | — |
410 | Dataservice has been deleted | — |
DELETE/dataservices/{dataservice}/datasets/{dataset}/
| Name | In | Required | Type |
|---|---|---|---|
dataservice | path | yes | string |
dataset | path | yes | string |
| Status | Description | Schema |
|---|---|---|
404 | Dataservice not found | — |
POST/dataservices/{dataservice}/featured/Mark a dataservice as featured
| Name | In | Required | Type |
|---|---|---|---|
dataservice | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Dataservice%20%28read%29 |
DELETE/dataservices/{dataservice}/featured/Unmark a dataservice as featured
| Name | In | Required | Type |
|---|---|---|---|
dataservice | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Dataservice%20%28read%29 |
GET/dataservices/{dataservice}/rdf
| Name | In | Required | Type |
|---|---|---|---|
dataservice | path | yes | string |
| Status | Description | Schema |
|---|---|---|
404 | Dataservice not found | — |
410 | Dataservice has been deleted | — |
GET/dataservices/{dataservice}/rdf.{_format}
| Name | In | Required | Type |
|---|---|---|---|
dataservice | path | yes | string |
_format | path | yes | string |
| Status | Description | Schema |
|---|---|---|
404 | Dataservice not found | — |
410 | Dataservice has been deleted | — |
GET/dataservices/{id}/followers/List all followers for a given object
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
page | query | no | integer |
page_size | query | no | integer |
user | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | FollowPage |
POST/dataservices/{id}/followers/Follow an object given its ID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
DELETE/dataservices/{id}/followers/Unfollow an object given its ID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
visualizations6
Visualizations related operations
GET/visualizations/List or search all visualizations
| Name | In | Required | Type |
|---|---|---|---|
page | query | no | integer |
page_size | query | no | integer |
sort | query | no | string |
owner | query | no | string |
organization | query | no | string |
private | query | no | boolean |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | ChartPage |
POST/visualizations/Create a new visualization
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — Chart%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
201 | Success | Chart%20%28read%29 |
400 | Validation error | — |
GET/visualizations/{visualization}/Get a visualization given its identifier
| Name | In | Required | Type |
|---|---|---|---|
visualization | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Chart%20%28read%29 |
PATCH/visualizations/{visualization}/Update a visualization given its identifier
| Name | In | Required | Type |
|---|---|---|---|
visualization | path | yes | string |
X-Fields | header | no | string |
application/json — Chart%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Chart%20%28read%29 |
400 | Validation error | — |
DELETE/visualizations/{visualization}/Delete a visualization given its identifier
| Name | In | Required | Type |
|---|---|---|---|
visualization | path | yes | string |
| Status | Description | Schema |
|---|---|---|
204 | Visualization deleted | — |
POST/visualizations/{visualization}/image/Upload a new visualization image
| Name | In | Required | Type |
|---|---|---|---|
visualization | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | UploadedImage |
discussions8
Discussion related operations
GET/discussions/List all Discussions
| Name | In | Required | Type |
|---|---|---|---|
page | query | no | integer |
page_size | query | no | integer |
sort | query | no | string |
q | query | no | string |
closed | query | no | boolean |
for | query | no | array |
org | query | no | string |
user | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | DiscussionPage |
POST/discussions/Create a new Discussion
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — DiscussionStart (required)
| Status | Description | Schema |
|---|---|---|
201 | Success | Discussion%20%28read%29 |
GET/discussions/{id}/Get a discussion given its ID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Discussion%20%28read%29 |
POST/discussions/{id}/Add comment and optionally close a discussion given its ID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
X-Fields | header | no | string |
application/json — DiscussionResponse (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Discussion%20%28read%29 |
403 | Not allowed to close this discussion OR can't add comments on a closed discussion | — |
PUT/discussions/{id}/Update a discussion given its ID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
X-Fields | header | no | string |
application/json — DiscussionEdit (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Discussion%20%28read%29 |
403 | Not allowed to update this discussion | — |
DELETE/discussions/{id}/Delete a discussion given its ID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
send_legal_notice | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
403 | Not allowed to delete this discussion | — |
PUT/discussions/{id}/comments/{cidx}/Edit a comment given its index or UUID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
cidx | path | yes | string |
X-Fields | header | no | string |
application/json — DiscussionEditComment (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Discussion%20%28read%29 |
403 | Not allowed to edit this comment | — |
DELETE/discussions/{id}/comments/{cidx}/Delete a comment given its index or UUID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
cidx | path | yes | string |
send_legal_notice | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
403 | Not allowed to delete this comment | — |
workers7
Asynchronous workers related operations
GET/workers/jobs/List all scheduled jobs
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
POST/workers/jobs/Create a new scheduled job
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — Job (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Job |
GET/workers/jobs/schedulables/List all schedulable jobs
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/workers/jobs/{id}/Fetch a single scheduled job
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Job |
PUT/workers/jobs/{id}/Update a single scheduled job
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Job |
DELETE/workers/jobs/{id}/Delete a single scheduled job
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
204 | Successfuly deleted | — |
GET/workers/tasks/{id}/Get a tasks status given its ID
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Task |
reports5
User reported objects related operations (beta)
GET/reports/
| Name | In | Required | Type |
|---|---|---|---|
page | query | no | integer |
page_size | query | no | integer |
sort | query | no | string |
handled | query | no | boolean |
subject_type | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | ReportPage |
POST/reports/
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — Report%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
201 | Success | Report%20%28read%29 |
400 | Validation error | — |
GET/reports/reasons/
| Status | Description | Schema |
|---|---|---|
200 | list of available reasons associated with their labels | — |
GET/reports/{report}/
| Name | In | Required | Type |
|---|---|---|---|
report | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Report%20%28read%29 |
PATCH/reports/{report}/
| Name | In | Required | Type |
|---|---|---|---|
report | path | yes | string |
X-Fields | header | no | string |
application/json — Report%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Report%20%28read%29 |
400 | Validation error | — |
tags1
Tags related operations
GET/tags/suggest/Suggest tags
| Name | In | Required | Type |
|---|---|---|---|
q | query | yes | string |
size | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
posts10
Posts related operations
GET/posts/List all posts
| Name | In | Required | Type |
|---|---|---|---|
page | query | no | integer |
page_size | query | no | integer |
sort | query | no | string |
q | query | no | string |
kind | query | no | string |
with_drafts | query | no | boolean |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | PostPage |
POST/posts/Create a post
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — Post%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Post%20%28read%29 |
400 | Validation error | — |
GET/posts/recent.atom
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/posts/{post}/Get a given post
| Name | In | Required | Type |
|---|---|---|---|
post | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Post%20%28read%29 |
404 | Object not found | — |
PUT/posts/{post}/Update a given post
| Name | In | Required | Type |
|---|---|---|---|
post | path | yes | string |
X-Fields | header | no | string |
application/json — Post%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Post%20%28read%29 |
400 | Validation error | — |
404 | Object not found | — |
DELETE/posts/{post}/Delete a given post
| Name | In | Required | Type |
|---|---|---|---|
post | path | yes | string |
| Status | Description | Schema |
|---|---|---|
204 | Object deleted | — |
404 | Object not found | — |
POST/posts/{post}/image/Upload a new image
| Name | In | Required | Type |
|---|---|---|---|
post | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | UploadedImage |
PUT/posts/{post}/image/Set the image BBox
| Name | In | Required | Type |
|---|---|---|---|
post | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | UploadedImage |
POST/posts/{post}/publish/Publish an existing post
| Name | In | Required | Type |
|---|---|---|---|
post | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Post%20%28read%29 |
DELETE/posts/{post}/publish/Unpublish an existing post
| Name | In | Required | Type |
|---|---|---|---|
post | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Post%20%28read%29 |
contacts5
Contact points related operations
POST/contacts/Creates a contact point
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — ContactPoint%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | ContactPoint%20%28read%29 |
400 | Validation error | — |
GET/contacts/roles/List all contact point roles
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
GET/contacts/{contact_point}/Get a contact point given its identifier
| Name | In | Required | Type |
|---|---|---|---|
contact_point | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | ContactPoint%20%28read%29 |
404 | Contact point not found | — |
PUT/contacts/{contact_point}/Updates a contact point given its identifier
| Name | In | Required | Type |
|---|---|---|---|
contact_point | path | yes | string |
X-Fields | header | no | string |
application/json — ContactPoint%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | ContactPoint%20%28read%29 |
400 | Validation error | — |
404 | Contact point not found | — |
DELETE/contacts/{contact_point}/Deletes a contact point given its identifier
| Name | In | Required | Type |
|---|---|---|---|
contact_point | path | yes | string |
| Status | Description | Schema |
|---|---|---|
204 | Contact point deleted | — |
404 | Contact point not found | — |
transfer4
GET/transfer/
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
POST/transfer/Initiate transfer request
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — TransferRequest (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Transfer |
GET/transfer/{id}/Fetch a transfer request given its identifier
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Transfer |
POST/transfer/{id}/Respond to a transfer request
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
X-Fields | header | no | string |
application/json — TransferResponse (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | Transfer |
notifications2
Notifications API
GET/notifications/List all current user pending notifications
| Name | In | Required | Type |
|---|---|---|---|
page | query | no | integer |
page_size | query | no | integer |
sort | query | no | string |
handled | query | no | boolean |
user | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | NotificationPage |
POST/notifications/{notification}/read/Read a notification
| Name | In | Required | Type |
|---|---|---|---|
notification | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | Notification%20%28read%29 |
400 | Validation error | — |
avatars1
Avatars
GET/avatars/{identifier}/{size}/Get a deterministic avatar given an identifier at a given size
| Name | In | Required | Type |
|---|---|---|---|
identifier | path | yes | string |
size | path | yes | integer |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
harvest15
Harvest related operations
GET/harvest/backends/List all available harvest backends
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | HarvestBackend |
GET/harvest/job/{ident}/Get a single job given an ID
| Name | In | Required | Type |
|---|---|---|---|
ident | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | HarvestJob%20%28read%29 |
GET/harvest/job/{ident}/items/List the items of a given harvest job (paginated)
| Name | In | Required | Type |
|---|---|---|---|
ident | path | yes | string |
page | query | no | integer |
page_size | query | no | integer |
status | query | no | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | HarvestItemPage |
POST/harvest/source/preview/Preview an harvesting from a source created with the given payload
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — HarvestSource%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | HarvestJobPreview |
GET/harvest/source/{source}/Get a single source given an ID or a slug
| Name | In | Required | Type |
|---|---|---|---|
source | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | HarvestSource%20%28read%29 |
PUT/harvest/source/{source}/Update a harvest source
| Name | In | Required | Type |
|---|---|---|---|
source | path | yes | string |
X-Fields | header | no | string |
application/json — HarvestSource%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | HarvestSource%20%28read%29 |
DELETE/harvest/source/{source}/
| Name | In | Required | Type |
|---|---|---|---|
source | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | HarvestSource%20%28read%29 |
GET/harvest/source/{source}/jobs/List all jobs for a given source
| Name | In | Required | Type |
|---|---|---|---|
source | path | yes | string |
page | query | no | integer |
page_size | query | no | integer |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | HarvestJobPage |
GET/harvest/source/{source}/preview/Preview a single harvest source given an ID or a slug
| Name | In | Required | Type |
|---|---|---|---|
source | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | HarvestJobPreview |
POST/harvest/source/{source}/run/
| Name | In | Required | Type |
|---|---|---|---|
source | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | HarvestSource%20%28read%29 |
POST/harvest/source/{source}/schedule/Schedule an harvest source
| Name | In | Required | Type |
|---|---|---|---|
source | path | yes | string |
X-Fields | header | no | string |
application/json (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | HarvestSource%20%28read%29 |
DELETE/harvest/source/{source}/schedule/Unschedule an harvest source
| Name | In | Required | Type |
|---|---|---|---|
source | path | yes | string |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | HarvestSource%20%28read%29 |
POST/harvest/source/{source}/validate/Validate or reject an harvest source
| Name | In | Required | Type |
|---|---|---|---|
source | path | yes | string |
X-Fields | header | no | string |
application/json — HarvestSourceValidation%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | HarvestSource%20%28read%29 |
GET/harvest/sources/List all harvest sources
| Name | In | Required | Type |
|---|---|---|---|
page | query | no | integer |
page_size | query | no | integer |
q | query | no | string |
owner | query | no | string |
organization | query | no | string |
deleted | query | no | boolean |
X-Fields | header | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Success | — |
POST/harvest/sources/Create a new harvest source
| Name | In | Required | Type |
|---|---|---|---|
X-Fields | header | no | string |
application/json — HarvestSource%20%28write%29 (required)
| Status | Description | Schema |
|---|---|---|
200 | Success | HarvestSource%20%28read%29 |
Try it
Developer reference
https://www.data.gouv.fr/api/1- GET/datasets/
- GET/datasets/{dataset}/
- GET/organizations/
Gotchas & limits
- The trailing slash on
/datasets/is mandatory — confirmed live this run:GET /api/1/datasets(no slash) returns 308, an HTML redirect body pointing at/api/1/datasets/; only the slashed path returns JSON directly. Code that doesn't follow redirects, or that switches a non-GET method to GET across the hop (as some HTTP clients do on 307/308), breaks here. page_sizehas no visible ceiling — live sweeps this run at 100/1000/5000 were all honored in full: 949,247 B, 9,423,595 B (9.4 MB), and 54,030,722 B (54 MB) respectively, withdata.lengthmatching the requested size exactly every time. Requesting a large page size with no server-side cap can pull tens of megabytes in one call.next_pagein the envelope is a full absolute URL (confirmed live above:https://www.data.gouv.fr/api/1/datasets/?page_size=1&page=2), not a relative path or bare cursor token — code that appends it ontobaseUrlagain will double the host.- The wildcard
access-control-allow-origin: *header is only sent back when the request itself carries anOriginheader — a live plain curl (noOrigin) got no CORS header at all, while the identical request withOrigin: https://example.comgot the wildcard back. That's expected CORS behavior, but a raw probe without an explicitOriginheader can look likecors: noby mistake. - The
/organizations/endpoint masks member emails in its JSON response — a live GET against/organizations/?page_size=1this run (200, 2,804 B) returned"email": "***@locaproplus.fr"for the listed member, so don't expect a real address back even though the field is present and non-null.
Availability
Changelog
- gained an OpenAPI spec