me

Connected user related operations

Fetch the current user (me) identity

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

Success

Body
aboutstring (markdown)

The user self description

activeboolean
avatarstring

The user avatar URL

avatar_thumbnailstring

The user avatar thumbnail URL. This is the square (500x500) and cropped version.

emailobject

The user email

first_name*string

The user first name

id*string

The user identifier

last_name*string

The user last name

metricsobject

The user metrics

organizationsarray of OrganizationReference (all of)

The organization the user belongs to

pagestring

The user profile page URL

rolesarray of string

Site wide user roles

since*string (date-time)

The registeration date

slug*string

The user permalink string

uri*string

The user API URI

websitestring

The user website

apikeystring

The user API Key

Request
const response = await fetch('//www.data.gouv.fr/api/1/me/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "about": "text",
  "active": false,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "first_name": "text",
  "id": "text",
  "last_name": "text",
  "organizations": [
    {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  ],
  "page": "text",
  "roles": [
    "text"
  ],
  "since": "2024-12-10T04:19:39.898Z",
  "slug": "text",
  "uri": "text",
  "website": "text",
  "apikey": "text"
}

Update my profile

PUT//www.data.gouv.fr/api/1/me/
Header parameters
Body
aboutstring (markdown)

The user self description

activeboolean
avatarstring

The user avatar URL

avatar_thumbnailstring

The user avatar thumbnail URL. This is the square (500x500) and cropped version.

emailobject

The user email

first_name*string

The user first name

id*string

The user identifier

last_name*string

The user last name

metricsobject

The user metrics

organizationsarray of OrganizationReference (all of)

The organization the user belongs to

pagestring

The user profile page URL

rolesarray of string

Site wide user roles

since*string (date-time)

The registeration date

slug*string

The user permalink string

uri*string

The user API URI

websitestring

The user website

apikeystring

The user API Key

Response

Success

Body
aboutstring (markdown)

The user self description

activeboolean
avatarstring

The user avatar URL

avatar_thumbnailstring

The user avatar thumbnail URL. This is the square (500x500) and cropped version.

emailobject

The user email

first_name*string

The user first name

id*string

The user identifier

last_name*string

The user last name

metricsobject

The user metrics

organizationsarray of OrganizationReference (all of)

The organization the user belongs to

pagestring

The user profile page URL

rolesarray of string

Site wide user roles

since*string (date-time)

The registeration date

slug*string

The user permalink string

uri*string

The user API URI

websitestring

The user website

apikeystring

The user API Key

Request
const response = await fetch('//www.data.gouv.fr/api/1/me/', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "first_name": "text",
      "id": "text",
      "last_name": "text",
      "since": "2024-12-10T04:19:39.898Z",
      "slug": "text",
      "uri": "text"
    }),
});
const data = await response.json();
Response
{
  "about": "text",
  "active": false,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "first_name": "text",
  "id": "text",
  "last_name": "text",
  "organizations": [
    {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  ],
  "page": "text",
  "roles": [
    "text"
  ],
  "since": "2024-12-10T04:19:39.898Z",
  "slug": "text",
  "uri": "text",
  "website": "text",
  "apikey": "text"
}

Delete my profile

DELETE//www.data.gouv.fr/api/1/me/
Response

Object deleted

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

(Re)Generate my API Key

POST//www.data.gouv.fr/api/1/me/apikey
Header parameters
Response

Success

Body
apikeystring

The user API Key

Request
const response = await fetch('//www.data.gouv.fr/api/1/me/apikey', {
    method: 'POST',
    headers: {},
});
const data = await response.json();
Response
{
  "apikey": "text"
}

Clear/destroy an apikey

DELETE//www.data.gouv.fr/api/1/me/apikey
Response

API Key deleted/cleared

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

List all my datasets (including private ones)

GET//www.data.gouv.fr/api/1/me/datasets/
Header parameters
Response

Success

Body
acronymstring

An optional dataset acronym

archivedstring (date-time)

The archival date if archived

badgesarray of Badge (object)

The dataset badges

community_resourcesarray of all of
contact_pointall of

The dataset's contact points

created_at*string (date-time)

This date is computed between harvested creation date if any and site's internal creation date

deletedstring (date-time)

The deletion date if deleted

description*string (markdown)

The dataset description in markdown

extrasobject

Extras attributes as key-value pairs

featuredboolean

Is the dataset featured

frequency*enum

The update frequency

Example: "unknown"
unknownpunctualcontinuoushourlyfourTimesADaythreeTimesADaysemidailydailyfourTimesAWeekthreeTimesAWeeksemiweeklyweeklybiweeklythreeTimesAMonthsemimonthlymonthlybimonthlyquarterlythreeTimesAYearsemiannualannualbiennialtriennialquinquennialirregular
frequency_datestring (date-time)

Next expected update date, you will be notified once that date is reached.

harvestall of

Dataset harvest metadata attributes

idstring

The dataset identifier

internalall of

Site internal and specific object's data

last_modified*string (date-time)

The dataset last modification date

last_update*string (date-time)

The resources last modification date

licensestring

The dataset license

metricsobject

The dataset metrics

organizationall of

The producer organization

ownerall of

The user information

page*string

The dataset page URL

privateboolean

Is the dataset private to the owner or the organization

qualityobject

The dataset quality

resourcesarray of all of
schemaall of

Reference to the associated schema

slug*string

The dataset permalink string

spatialall of

The spatial coverage

tagsarray of string
temporal_coverageall of

The temporal coverage

title*string

The dataset title

uri*string

The dataset API URI

Request
const response = await fetch('//www.data.gouv.fr/api/1/me/datasets/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "acronym": "text",
    "archived": "2024-12-10T04:19:39.898Z",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "community_resources": [
      {
        "checksum": {
          "type": "sha1",
          "value": "text"
        },
        "created_at": "2024-12-10T04:19:39.898Z",
        "description": "text",
        "filesize": 0,
        "filetype": "file",
        "format": "text",
        "harvest": {
          "created_at": "2024-12-10T04:19:39.898Z",
          "modified_at": "2024-12-10T04:19:39.898Z",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2024-12-10T04:19:39.898Z",
          "last_modified_internal": "2024-12-10T04:19:39.898Z"
        },
        "last_modified": "2024-12-10T04:19:39.898Z",
        "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": {
      "contact_form": "text",
      "email": "text",
      "id": "text",
      "name": "text",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    },
    "created_at": "2024-12-10T04:19:39.898Z",
    "deleted": "2024-12-10T04:19:39.898Z",
    "description": "text",
    "featured": false,
    "frequency": "unknown",
    "frequency_date": "2024-12-10T04:19:39.898Z",
    "harvest": {
      "archived": "text",
      "archived_at": "2024-12-10T04:19:39.898Z",
      "backend": "text",
      "ckan_name": "text",
      "ckan_source": "text",
      "created_at": "2024-12-10T04:19:39.898Z",
      "dct_identifier": "text",
      "domain": "text",
      "last_update": "2024-12-10T04:19:39.898Z",
      "modified_at": "2024-12-10T04:19:39.898Z",
      "remote_id": "text",
      "remote_url": "text",
      "source_id": "text",
      "uri": "text"
    },
    "id": "text",
    "internal": {
      "created_at_internal": "2024-12-10T04:19:39.898Z",
      "last_modified_internal": "2024-12-10T04:19:39.898Z"
    },
    "last_modified": "2024-12-10T04:19:39.898Z",
    "last_update": "2024-12-10T04:19:39.898Z",
    "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-12-10T04:19:39.898Z",
        "description": "text",
        "filesize": 0,
        "filetype": "file",
        "format": "text",
        "harvest": {
          "created_at": "2024-12-10T04:19:39.898Z",
          "modified_at": "2024-12-10T04:19:39.898Z",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2024-12-10T04:19:39.898Z",
          "last_modified_internal": "2024-12-10T04:19:39.898Z"
        },
        "last_modified": "2024-12-10T04:19:39.898Z",
        "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-12-10T04:19:39.898Z",
      "start": "2024-12-10T04:19:39.898Z"
    },
    "title": "text",
    "uri": "text"
  }
]

Fetch the current user (me) metrics

GET//www.data.gouv.fr/api/1/me/metrics/
Header parameters
Response

Success

Body
datasets_countinteger

The user's datasets number

datasets_org_countinteger

The user's orgs datasets number

followers_countinteger

The user's followers number

followers_org_countinteger

The user's orgs followers number

id*string

The user identifier

resources_availabilitynumber

The user's resources availability percentage

Request
const response = await fetch('//www.data.gouv.fr/api/1/me/metrics/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "datasets_count": 0,
    "datasets_org_count": 0,
    "followers_count": 0,
    "followers_org_count": 0,
    "id": "text",
    "resources_availability": 0
  }
]

List all community resources related to me and my organizations

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

Success

Body
checksumall of

A checksum to validate file validity

created_atstring (date-time)

The resource creation date

descriptionstring (markdown)

The resource markdown description

extrasobject

Extra attributes as key-value pairs

filesizeinteger

The resource file size in bytes

filetype*enum

Whether the resource is an uploaded file, a remote file or an API

Example: "file"
fileremote
format*string

The resource format

harvestall of

Harvest attributes metadata information

idstring

The resource unique ID

internalall of

Site internal and specific object's data

last_modifiedstring (date-time)

The resource last modification date

lateststring

The permanent URL redirecting to the latest version of the resource. When the resource data is updated, the URL will change, the latest URL won't.

metricsobject

The resource metrics

mimestring

The resource mime type

preview_urlstring

An optional preview URL to be loaded as a standalone page (ie. iframe or new page)

schemaall of

Reference to the associated schema

title*string

The resource title

type*enum

Resource type (documentation, API...)

Example: "main"
maindocumentationupdateapicodeother
url*string

The resource URL

datasetall of

Reference to the associated dataset

organizationall of

The producer organization

ownerall of

The user information

Request
const response = await fetch('//www.data.gouv.fr/api/1/me/org_community_resources/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "checksum": {
      "type": "sha1",
      "value": "text"
    },
    "created_at": "2024-12-10T04:19:39.898Z",
    "description": "text",
    "filesize": 0,
    "filetype": "file",
    "format": "text",
    "harvest": {
      "created_at": "2024-12-10T04:19:39.898Z",
      "modified_at": "2024-12-10T04:19:39.898Z",
      "uri": "text"
    },
    "id": "text",
    "internal": {
      "created_at_internal": "2024-12-10T04:19:39.898Z",
      "last_modified_internal": "2024-12-10T04:19:39.898Z"
    },
    "last_modified": "2024-12-10T04:19:39.898Z",
    "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"
    }
  }
]

List all datasets related to me and my organizations

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

Success

Body
acronymstring

An optional dataset acronym

archivedstring (date-time)

The archival date if archived

badgesarray of Badge (object)

The dataset badges

community_resourcesarray of all of
contact_pointall of

The dataset's contact points

created_at*string (date-time)

This date is computed between harvested creation date if any and site's internal creation date

deletedstring (date-time)

The deletion date if deleted

description*string (markdown)

The dataset description in markdown

extrasobject

Extras attributes as key-value pairs

featuredboolean

Is the dataset featured

frequency*enum

The update frequency

Example: "unknown"
unknownpunctualcontinuoushourlyfourTimesADaythreeTimesADaysemidailydailyfourTimesAWeekthreeTimesAWeeksemiweeklyweeklybiweeklythreeTimesAMonthsemimonthlymonthlybimonthlyquarterlythreeTimesAYearsemiannualannualbiennialtriennialquinquennialirregular
frequency_datestring (date-time)

Next expected update date, you will be notified once that date is reached.

harvestall of

Dataset harvest metadata attributes

idstring

The dataset identifier

internalall of

Site internal and specific object's data

last_modified*string (date-time)

The dataset last modification date

last_update*string (date-time)

The resources last modification date

licensestring

The dataset license

metricsobject

The dataset metrics

organizationall of

The producer organization

ownerall of

The user information

page*string

The dataset page URL

privateboolean

Is the dataset private to the owner or the organization

qualityobject

The dataset quality

resourcesarray of all of
schemaall of

Reference to the associated schema

slug*string

The dataset permalink string

spatialall of

The spatial coverage

tagsarray of string
temporal_coverageall of

The temporal coverage

title*string

The dataset title

uri*string

The dataset API URI

Request
const response = await fetch('//www.data.gouv.fr/api/1/me/org_datasets/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "acronym": "text",
    "archived": "2024-12-10T04:19:39.898Z",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "community_resources": [
      {
        "checksum": {
          "type": "sha1",
          "value": "text"
        },
        "created_at": "2024-12-10T04:19:39.898Z",
        "description": "text",
        "filesize": 0,
        "filetype": "file",
        "format": "text",
        "harvest": {
          "created_at": "2024-12-10T04:19:39.898Z",
          "modified_at": "2024-12-10T04:19:39.898Z",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2024-12-10T04:19:39.898Z",
          "last_modified_internal": "2024-12-10T04:19:39.898Z"
        },
        "last_modified": "2024-12-10T04:19:39.898Z",
        "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": {
      "contact_form": "text",
      "email": "text",
      "id": "text",
      "name": "text",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    },
    "created_at": "2024-12-10T04:19:39.898Z",
    "deleted": "2024-12-10T04:19:39.898Z",
    "description": "text",
    "featured": false,
    "frequency": "unknown",
    "frequency_date": "2024-12-10T04:19:39.898Z",
    "harvest": {
      "archived": "text",
      "archived_at": "2024-12-10T04:19:39.898Z",
      "backend": "text",
      "ckan_name": "text",
      "ckan_source": "text",
      "created_at": "2024-12-10T04:19:39.898Z",
      "dct_identifier": "text",
      "domain": "text",
      "last_update": "2024-12-10T04:19:39.898Z",
      "modified_at": "2024-12-10T04:19:39.898Z",
      "remote_id": "text",
      "remote_url": "text",
      "source_id": "text",
      "uri": "text"
    },
    "id": "text",
    "internal": {
      "created_at_internal": "2024-12-10T04:19:39.898Z",
      "last_modified_internal": "2024-12-10T04:19:39.898Z"
    },
    "last_modified": "2024-12-10T04:19:39.898Z",
    "last_update": "2024-12-10T04:19:39.898Z",
    "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-12-10T04:19:39.898Z",
        "description": "text",
        "filesize": 0,
        "filetype": "file",
        "format": "text",
        "harvest": {
          "created_at": "2024-12-10T04:19:39.898Z",
          "modified_at": "2024-12-10T04:19:39.898Z",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2024-12-10T04:19:39.898Z",
          "last_modified_internal": "2024-12-10T04:19:39.898Z"
        },
        "last_modified": "2024-12-10T04:19:39.898Z",
        "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-12-10T04:19:39.898Z",
      "start": "2024-12-10T04:19:39.898Z"
    },
    "title": "text",
    "uri": "text"
  }
]

List all discussions related to my organizations

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

Success

Body
class*string

The object class

closedstring (date-time)

The discussion closing date

closed_byall of

The user who closed the discussion

createdstring (date-time)

The discussion creation date

discussionDiscussionMessage (object)
extrasobject

Extra attributes as key-value pairs

idstring

The discussion identifier

spamSpam (object)
subjectall of

The discussion target object

titlestring

The discussion title

urlstring

The discussion API URI

userall of

The discussion author

Request
const response = await fetch('//www.data.gouv.fr/api/1/me/org_discussions/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "class": "text",
    "closed": "2024-12-10T04:19:39.898Z",
    "closed_by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",