reuses

Reuse related operations

GET//www.data.gouv.fr/api/1/reuses/
Query parameters
Header parameters
Response

Success

Body
dataarray of Reuse_read_ (object)

The page data

next_pagestring

The next page URL if exists

page*integer

The current page

page_size*integer

The page size used for pagination

previous_pagestring

The previous page URL if exists

total*integer

The total paginated items

Request
const response = await fetch('//www.data.gouv.fr/api/1/reuses/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "data": [
    {
      "archived": "2024-09-15T09:33:10.635Z",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "created_at": "2024-09-15T09:33:10.635Z",
      "datasets": [
        {
          "acronym": "text",
          "archived": "2024-09-15T09:33:10.635Z",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "community_resources": [
            {
              "checksum": {
                "type": "sha1",
                "value": "text"
              },
              "created_at": "2024-09-15T09:33:10.635Z",
              "description": "text",
              "filetype": "file",
              "format": "text",
              "harvest": {
                "created_at": "2024-09-15T09:33:10.635Z",
                "modified_at": "2024-09-15T09:33:10.635Z",
                "uri": "text"
              },
              "id": "text",
              "internal": {
                "created_at_internal": "2024-09-15T09:33:10.635Z",
                "last_modified_internal": "2024-09-15T09:33:10.635Z"
              },
              "last_modified": "2024-09-15T09:33:10.635Z",
              "latest": "text",
              "mime": "text",
              "preview_url": "text",
              "schema": {
                "name": "text",
                "url": "text",
                "version": "text"
              },
              "title": "text",
              "type": "main",
              "url": "text",
              "dataset": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "page": "text",
                "title": "text",
                "uri": "text"
              },
              "organization": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "badges": [
                  {
                    "kind": "text"
                  }
                ],
                "logo": "text",
                "logo_thumbnail": "text",
                "name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              },
              "owner": {
                "class": "text",
                "id": "text",
                "avatar": "text",
                "avatar_thumbnail": "text",
                "first_name": "text",
                "last_name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              }
            }
          ],
          "contact_point": {
            "email": "text",
            "id": "text",
            "name": "text",
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ],
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            }
          },
          "created_at": "2024-09-15T09:33:10.635Z",
          "deleted": "2024-09-15T09:33:10.635Z",
          "description": "text",
          "featured": false,
          "frequency": "unknown",
          "frequency_date": "2024-09-15T09:33:10.635Z",
          "harvest": {
            "archived": "text",
            "archived_at": "2024-09-15T09:33:10.635Z",
            "backend": "text",
            "ckan_name": "text",
            "ckan_source": "text",
            "created_at": "2024-09-15T09:33:10.635Z",
            "dct_identifier": "text",
            "domain": "text",
            "last_update": "2024-09-15T09:33:10.635Z",
            "modified_at": "2024-09-15T09:33:10.635Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-09-15T09:33:10.635Z",
            "last_modified_internal": "2024-09-15T09:33:10.635Z"
          },
          "last_modified": "2024-09-15T09:33:10.635Z",
          "last_update": "2024-09-15T09:33:10.635Z",
          "license": "notspecified",
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "badges": [
              {
                "kind": "text"
              }
            ],
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "page": "text",
          "private": false,
          "resources": [
            {
              "checksum": {
                "type": "sha1",
                "value": "text"
              },
              "created_at": "2024-09-15T09:33:10.635Z",
              "description": "text",
              "filetype": "file",
              "format": "text",
              "harvest": {
                "created_at": "2024-09-15T09:33:10.635Z",
                "modified_at": "2024-09-15T09:33:10.635Z",
                "uri": "text"
              },
              "id": "text",
              "internal": {
                "created_at_internal": "2024-09-15T09:33:10.635Z",
                "last_modified_internal": "2024-09-15T09:33:10.635Z"
              },
              "last_modified": "2024-09-15T09:33:10.635Z",
              "latest": "text",
              "mime": "text",
              "preview_url": "text",
              "schema": {
                "name": "text",
                "url": "text",
                "version": "text"
              },
              "title": "text",
              "type": "main",
              "url": "text"
            }
          ],
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "slug": "text",
          "spatial": {
            "geom": {
              "coordinates": [],
              "type": "Point"
            },
            "granularity": "other",
            "zones": [
              "text"
            ]
          },
          "tags": [
            "text"
          ],
          "temporal_coverage": {
            "end": "2024-09-15T09:33:10.635Z",
            "start": "2024-09-15T09:33:10.635Z"
          },
          "title": "text",
          "uri": "text"
        }
      ],
      "deleted": "2024-09-15T09:33:10.635Z",
      "description": "text",
      "featured": false,
      "id": "text",
      "image": "text",
      "image_thumbnail": "text",
      "last_modified": "2024-09-15T09:33:10.635Z",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "page": "text",
      "private": false,
      "slug": "text",
      "tags": [
        "text"
      ],
      "title": "text",
      "topic": "health",
      "type": "api",
      "uri": "text",
      "url": "text"
    }
  ],
  "next_page": "text",
  "previous_page": "text"
}

POST//www.data.gouv.fr/api/1/reuses/
Header parameters
Body
archivedstring (date-time)
datasetsarray of string
description*string (markdown)
extrasobject
organizationstring

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

ownerstring

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

privateboolean
tagsarray of string
title*string
topic*enum
Example: "health"
healthtransport_and_mobilityhousing_and_developmentfood_and_agricultureculture_and_recreationeconomy_and_businessenvironment_and_energywork_and_trainingpolitics_and_public_lifesafety_and_securityeducation_and_researchsociety_and_demographylaw_and_justiceopen_data_toolsothers
type*enum
Example: "api"
apiapplicationideanews_articlepaperpostvisualizationhardware
url*string

The remote URL (website)

Response

Success

Body
archivedstring (date-time)
badgesarray of all of
created_at*string (date-time)
datasetsarray of Dataset (object)
deletedstring (date-time)
description*string (markdown)
extrasobject
featuredboolean
id*string
imagestring

URL of the image

image_thumbnailstring

URL of the cropped and squared image (500x500)

last_modified*string (date-time)
metricsobject
organizationall of

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

ownerall of

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

pagestring

Link to the udata web page for this reuse

privateboolean
slug*string
tagsarray of string
title*string
topic*enum
Example: "health"
healthtransport_and_mobilityhousing_and_developmentfood_and_agricultureculture_and_recreationeconomy_and_businessenvironment_and_energywork_and_trainingpolitics_and_public_lifesafety_and_securityeducation_and_researchsociety_and_demographylaw_and_justiceopen_data_toolsothers
type*enum
Example: "api"
apiapplicationideanews_articlepaperpostvisualizationhardware
uristring

Link to the API endpoint for this reuse

url*string

The remote URL (website)

Request
const response = await fetch('//www.data.gouv.fr/api/1/reuses/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "text",
      "title": "text",
      "topic": "health",
      "type": "api",
      "url": "text"
    }),
});
const data = await response.json();
Response
{
  "archived": "2024-09-15T09:33:10.635Z",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "created_at": "2024-09-15T09:33:10.635Z",
  "datasets": [
    {
      "acronym": "text",
      "archived": "2024-09-15T09:33:10.635Z",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "community_resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-09-15T09:33:10.635Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-09-15T09:33:10.635Z",
            "modified_at": "2024-09-15T09:33:10.635Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-09-15T09:33:10.635Z",
            "last_modified_internal": "2024-09-15T09:33:10.635Z"
          },
          "last_modified": "2024-09-15T09:33:10.635Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text",
          "dataset": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "page": "text",
            "title": "text",
            "uri": "text"
          },
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "badges": [
              {
                "kind": "text"
              }
            ],
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        }
      ],
      "contact_point": {
        "email": "text",
        "id": "text",
        "name": "text",
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        }
      },
      "created_at": "2024-09-15T09:33:10.635Z",
      "deleted": "2024-09-15T09:33:10.635Z",
      "description": "text",
      "featured": false,
      "frequency": "unknown",
      "frequency_date": "2024-09-15T09:33:10.635Z",
      "harvest": {
        "archived": "text",
        "archived_at": "2024-09-15T09:33:10.635Z",
        "backend": "text",
        "ckan_name": "text",
        "ckan_source": "text",
        "created_at": "2024-09-15T09:33:10.635Z",
        "dct_identifier": "text",
        "domain": "text",
        "last_update": "2024-09-15T09:33:10.635Z",
        "modified_at": "2024-09-15T09:33:10.635Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2024-09-15T09:33:10.635Z",
        "last_modified_internal": "2024-09-15T09:33:10.635Z"
      },
      "last_modified": "2024-09-15T09:33:10.635Z",
      "last_update": "2024-09-15T09:33:10.635Z",
      "license": "notspecified",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "page": "text",
      "private": false,
      "resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-09-15T09:33:10.635Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-09-15T09:33:10.635Z",
            "modified_at": "2024-09-15T09:33:10.635Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-09-15T09:33:10.635Z",
            "last_modified_internal": "2024-09-15T09:33:10.635Z"
          },
          "last_modified": "2024-09-15T09:33:10.635Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text"
        }
      ],
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "slug": "text",
      "spatial": {
        "geom": {
          "coordinates": [],
          "type": "Point"
        },
        "granularity": "other",
        "zones": [
          "text"
        ]
      },
      "tags": [
        "text"
      ],
      "temporal_coverage": {
        "end": "2024-09-15T09:33:10.635Z",
        "start": "2024-09-15T09:33:10.635Z"
      },
      "title": "text",
      "uri": "text"
    }
  ],
  "deleted": "2024-09-15T09:33:10.635Z",
  "description": "text",
  "featured": false,
  "id": "text",
  "image": "text",
  "image_thumbnail": "text",
  "last_modified": "2024-09-15T09:33:10.635Z",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "page": "text",
  "private": false,
  "slug": "text",
  "tags": [
    "text"
  ],
  "title": "text",
  "topic": "health",
  "type": "api",
  "uri": "text",
  "url": "text"
}

List all available reuse badges and their labels

GET//www.data.gouv.fr/api/1/reuses/badges/
Response

Success

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

Reuses suggest endpoint using mongoDB contains

GET//www.data.gouv.fr/api/1/reuses/suggest/
Query parameters
Header parameters
Response

Success

Body
idstring

The reuse identifier

image_urlstring

The reuse thumbnail URL

pagestring

The reuse page URL

slugstring

The reuse permalink string

titlestring

The reuse title

Request
const response = await fetch('//www.data.gouv.fr/api/1/reuses/suggest/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "id": "text",
    "image_url": "text",
    "page": "text",
    "slug": "text",
    "title": "text"
  }
]

List all reuse topics

GET//www.data.gouv.fr/api/1/reuses/topics/
Header parameters
Response

Success

Body
idstring

The reuse topic identifier

labelstring

The reuse topic display name

Request
const response = await fetch('//www.data.gouv.fr/api/1/reuses/topics/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "id": "text",
    "label": "text"
  }
]

List all reuse types

GET//www.data.gouv.fr/api/1/reuses/types/
Header parameters
Response

Success

Body
idstring

The reuse type identifier

labelstring

The reuse type display name

Request
const response = await fetch('//www.data.gouv.fr/api/1/reuses/types/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "id": "text",
    "label": "text"
  }
]

List all followers for a given object

GET//www.data.gouv.fr/api/1/reuses/{id}/followers/
Path parameters
id*string
Query parameters
Header parameters
Response

Success

Body
dataarray of Follow (object)

The page data

next_pagestring

The next page URL if exists

page*integer

The current page

page_size*integer

The page size used for pagination

previous_pagestring

The previous page URL if exists

total*integer

The total paginated items

Request
const response = await fetch('//www.data.gouv.fr/api/1/reuses/{id}/followers/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "data": [
    {
      "follower": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "id": "text",
      "since": "2024-09-15T09:33:10.635Z"
    }
  ],
  "next_page": "text",
  "previous_page": "text"
}

Follow an object given its ID

Returns the number of followers left after the operation

POST//www.data.gouv.fr/api/1/reuses/{id}/followers/
Path parameters
id*string
Response

Success

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

Unfollow an object given its ID

Returns the number of followers left after the operation

DELETE//www.data.gouv.fr/api/1/reuses/{id}/followers/
Path parameters
id*string
Response

Success

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

Fetch a given reuse

GET//www.data.gouv.fr/api/1/reuses/{reuse}/
Path parameters
reuse*string

The reuse ID or slug

Header parameters
Response

Success

Body
archivedstring (date-time)
badgesarray of all of
created_at*string (date-time)
datasetsarray of Dataset (object)
deletedstring (date-time)
description*string (markdown)
extrasobject
featuredboolean
id*string
imagestring

URL of the image

image_thumbnailstring

URL of the cropped and squared image (500x500)

last_modified*string (date-time)
metricsobject
organizationall of

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

ownerall of

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

pagestring

Link to the udata web page for this reuse

privateboolean
slug*string
tagsarray of string
title*string
topic*enum
Example: "health"
healthtransport_and_mobilityhousing_and_developmentfood_and_agricultureculture_and_recreationeconomy_and_businessenvironment_and_energywork_and_trainingpolitics_and_public_lifesafety_and_securityeducation_and_researchsociety_and_demographylaw_and_justiceopen_data_toolsothers
type*enum
Example: "api"
apiapplicationideanews_articlepaperpostvisualizationhardware
uristring

Link to the API endpoint for this reuse

url*string

The remote URL (website)

Request
const response = await fetch('//www.data.gouv.fr/api/1/reuses/{reuse}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "archived": "2024-09-15T09:33:10.635Z",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "created_at": "2024-09-15T09:33:10.635Z",
  "datasets": [
    {
      "acronym": "text",
      "archived": "2024-09-15T09:33:10.635Z",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "community_resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2024-09-15T09:33:10.635Z",
          "description": "text",
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2024-09-15T09:33:10.635Z",
            "modified_at": "2024-09-15T09:33:10.635Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2024-09-15T09:33:10.635Z",
            "last_modified_internal": "2024-09-15T09:33:10.635Z"
          },
          "last_modified": "2024-09-15T09:33:10.635Z",
          "latest": "text",
          "mime": "text",
          "preview_url": "text",
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "title": "text",
          "type": "main",
          "url": "text",
          "dataset": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "page": "text",
            "title": "text",
            "uri": "text"
          },
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "badges": [
              {
                "kind": "text"
              }
            ],
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        }
      ],
      "contact_point": {
        "email": "text",
        "id": "text",
        "name": "text",
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "owner": {