users

User related operations

List all users

get

Paramètres de requête

qstringOptionnel

The search query

sortstring · enumOptionnel

The field (and direction) on which sorting apply

Valeurs possibles:

pageintegerOptionnel

The page to fetch

page_sizeintegerOptionnel

The page size to fetch

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

next_pagestringOptionnel

The next page URL if exists

pageinteger · min: 1Requis

The current page

page_sizeintegerRequis

The page size used for pagination

previous_pagestringOptionnel

The previous page URL if exists

totalintegerRequis

The total paginated items

get/users/

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

200

Success

{
  "data": [
    {
      "about": "text",
      "active": true,
      "avatar": "text",
      "avatar_thumbnail": "text",
      "deleted": "2026-01-01T00:00:00.000Z",
      "email": "text",
      "first_name": "text",
      "id": "text",
      "last_login_at": "2026-01-01T00:00:00.000Z",
      "last_name": "text",
      "mail_cadence": "immediate",
      "metrics": {},
      "notifications_paused": true,
      "organizations": [
        {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "permissions": {
            "delete": true,
            "edit": true,
            "harvest": true,
            "members": true,
            "private": true
          },
          "slug": "text",
          "uri": "text"
        }
      ],
      "page": "text",
      "password_rotation_demanded": "2026-01-01T00:00:00.000Z",
      "password_rotation_performed": "2026-01-01T00:00:00.000Z",
      "roles": [
        "text"
      ],
      "since": "2026-01-01T00:00:00.000Z",
      "slug": "text",
      "uri": "text",
      "website": "text"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Create a new user

post

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

aboutstring · markdownOptionnel

emailstring · max: 255Requis

first_namestring · max: 255Requis

last_namestring · max: 255Requis

mail_cadencestring · enumRequisExample: immediateValeurs possibles:

notifications_pausedbooleanOptionnel

websitestringOptionnel

Réponses

201

Success

application/json

aboutstring · markdownOptionnel

activebooleanLecture seuleOptionnel

avatarstringLecture seuleOptionnel

URL of the image

avatar_thumbnailstringLecture seuleOptionnel

URL of the cropped and squared image (500x500)

deletedstring · date-timeLecture seuleOptionnel

The date the account was deleted, null for a live account

emailstring · max: 255Requis

first_namestring · max: 255Requis

idstringLecture seuleRequis

last_login_atstring · date-timeLecture seuleOptionnel

last_namestring · max: 255Requis

mail_cadencestring · enumRequisExample: immediateValeurs possibles:

metricsobjectLecture seuleOptionnel

notifications_pausedbooleanOptionnel

pagestringLecture seuleOptionnel

Link to the udata web page for this user

password_rotation_demandedstring · date-timeLecture seuleOptionnel

password_rotation_performedstring · date-timeLecture seuleOptionnel

rolesstring[]Lecture seuleOptionnel

sincestring · date-timeLecture seuleRequis

slugstring · max: 255Lecture seuleRequis

uristringLecture seuleOptionnel

Link to the API endpoint for this user

websitestringOptionnel

400

Validation error

post/users/

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

{
  "about": "text",
  "email": "text",
  "first_name": "text",
  "last_name": "text",
  "mail_cadence": "immediate",
  "notifications_paused": true,
  "website": "text"
}

{
  "about": "text",
  "active": true,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "deleted": "2026-01-01T00:00:00.000Z",
  "email": "text",
  "first_name": "text",
  "id": "text",
  "last_login_at": "2026-01-01T00:00:00.000Z",
  "last_name": "text",
  "mail_cadence": "immediate",
  "metrics": {},
  "notifications_paused": true,
  "organizations": [
    {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "permissions": {
        "delete": true,
        "edit": true,
        "harvest": true,
        "members": true,
        "private": true
      },
      "slug": "text",
      "uri": "text"
    }
  ],
  "page": "text",
  "password_rotation_demanded": "2026-01-01T00:00:00.000Z",
  "password_rotation_performed": "2026-01-01T00:00:00.000Z",
  "roles": [
    "text"
  ],
  "since": "2026-01-01T00:00:00.000Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}

List all possible user roles

get

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

namestringLecture seuleOptionnel

The role name

get/users/roles/

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

200

Success

[
  {
    "name": "text"
  }
]

Suggest users

get

Paramètres de requête

qstringRequis

The string to autocomplete/suggest

sizestringOptionnel

The amount of suggestion to fetch (between 1 and 20)

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

avatar_urlstringLecture seuleOptionnel

The user avatar URL

emailobjectLecture seuleOptionnel

The user email (only the domain for non-admin user)

first_namestringLecture seuleOptionnel

The user first name

idstringLecture seuleOptionnel

The user identifier

last_namestringLecture seuleOptionnel

The user last name

slugstringLecture seuleOptionnel

The user permalink string

get/users/suggest/

GET /api/1/users/suggest/?q=text HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  {
    "avatar_url": "text",
    "email": {},
    "first_name": "text",
    "id": "text",
    "last_name": "text",
    "slug": "text"
  }
]

List all followers for a given object

get

Paramètres de chemin

idstringRequis

Paramètres de requête

pageintegerOptionnel

The page to fetch

page_sizeintegerOptionnel

The page size to fetch

userstringOptionnel

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

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

next_pagestringOptionnel

The next page URL if exists

pageinteger · min: 1Requis

The current page

page_sizeintegerRequis

The page size used for pagination

previous_pagestringOptionnel

The previous page URL if exists

totalintegerRequis

The total paginated items

get/users/{id}/followers/

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

200

Success

{
  "data": [
    {
      "follower": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "deleted": "2026-01-01T00:00:00.000Z",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "id": "text",
      "since": "2026-01-01T00:00:00.000Z"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Follow a user given its ID

post

Paramètres de chemin

idstringRequis

Réponses

403

When trying to follow yourself

Aucun contenu

post/users/{id}/followers/

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

403

When trying to follow yourself

Aucun contenu

Unfollow an object given its ID

delete

Returns the number of followers left after the operation

Paramètres de chemin

idstringRequis

Réponses

200

Success

Aucun contenu

delete/users/{id}/followers/

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

200

Success

Aucun contenu

Get a user given its identifier

get

Paramètres de chemin

userstringRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

aboutstring · markdownOptionnel

activebooleanLecture seuleOptionnel

avatarstringLecture seuleOptionnel

URL of the image

avatar_thumbnailstringLecture seuleOptionnel

URL of the cropped and squared image (500x500)

deletedstring · date-timeLecture seuleOptionnel

The date the account was deleted, null for a live account

emailstring · max: 255Requis

first_namestring · max: 255Requis

idstringLecture seuleRequis

last_login_atstring · date-timeLecture seuleOptionnel

last_namestring · max: 255Requis

mail_cadencestring · enumRequisExample: immediateValeurs possibles:

metricsobjectLecture seuleOptionnel

notifications_pausedbooleanOptionnel

pagestringLecture seuleOptionnel

Link to the udata web page for this user

password_rotation_demandedstring · date-timeLecture seuleOptionnel

password_rotation_performedstring · date-timeLecture seuleOptionnel

rolesstring[]Lecture seuleOptionnel

sincestring · date-timeLecture seuleRequis

slugstring · max: 255Lecture seuleRequis

uristringLecture seuleOptionnel

Link to the API endpoint for this user

websitestringOptionnel

404

User not found

410

User is not active or has been deleted

get/users/{user}/

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

{
  "about": "text",
  "active": true,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "deleted": "2026-01-01T00:00:00.000Z",
  "email": "text",
  "first_name": "text",
  "id": "text",
  "last_login_at": "2026-01-01T00:00:00.000Z",
  "last_name": "text",
  "mail_cadence": "immediate",
  "metrics": {},
  "notifications_paused": true,
  "organizations": [
    {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "permissions": {
        "delete": true,
        "edit": true,
        "harvest": true,
        "members": true,
        "private": true
      },
      "slug": "text",
      "uri": "text"
    }
  ],
  "page": "text",
  "password_rotation_demanded": "2026-01-01T00:00:00.000Z",
  "password_rotation_performed": "2026-01-01T00:00:00.000Z",
  "roles": [
    "text"
  ],
  "since": "2026-01-01T00:00:00.000Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}

Update a user given its identifier

put

Paramètres de chemin

userstringRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

aboutstring · markdownOptionnel

emailstring · max: 255Requis

first_namestring · max: 255Requis

last_namestring · max: 255Requis

mail_cadencestring · enumRequisExample: immediateValeurs possibles:

notifications_pausedbooleanOptionnel

websitestringOptionnel

Réponses

200

Success

application/json

aboutstring · markdownOptionnel

activebooleanLecture seuleOptionnel

avatarstringLecture seuleOptionnel

URL of the image

avatar_thumbnailstringLecture seuleOptionnel

URL of the cropped and squared image (500x500)

deletedstring · date-timeLecture seuleOptionnel

The date the account was deleted, null for a live account

emailstring · max: 255Requis

first_namestring · max: 255Requis

idstringLecture seuleRequis

last_login_atstring · date-timeLecture seuleOptionnel

last_namestring · max: 255Requis

mail_cadencestring · enumRequisExample: immediateValeurs possibles:

metricsobjectLecture seuleOptionnel

notifications_pausedbooleanOptionnel

pagestringLecture seuleOptionnel

Link to the udata web page for this user

password_rotation_demandedstring · date-timeLecture seuleOptionnel

password_rotation_performedstring · date-timeLecture seuleOptionnel

rolesstring[]Lecture seuleOptionnel

sincestring · date-timeLecture seuleRequis

slugstring · max: 255Lecture seuleRequis

uristringLecture seuleOptionnel

Link to the API endpoint for this user

websitestringOptionnel

400

Validation error

404

User not found

410

User is not active or has been deleted

put/users/{user}/

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

{
  "about": "text",
  "email": "text",
  "first_name": "text",
  "last_name": "text",
  "mail_cadence": "immediate",
  "notifications_paused": true,
  "website": "text"
}

{
  "about": "text",
  "active": true,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "deleted": "2026-01-01T00:00:00.000Z",
  "email": "text",
  "first_name": "text",
  "id": "text",
  "last_login_at": "2026-01-01T00:00:00.000Z",
  "last_name": "text",
  "mail_cadence": "immediate",
  "metrics": {},
  "notifications_paused": true,
  "organizations": [
    {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "permissions": {
        "delete": true,
        "edit": true,
        "harvest": true,
        "members": true,
        "private": true
      },
      "slug": "text",
      "uri": "text"
    }
  ],
  "page": "text",
  "password_rotation_demanded": "2026-01-01T00:00:00.000Z",
  "password_rotation_performed": "2026-01-01T00:00:00.000Z",
  "roles": [
    "text"
  ],
  "since": "2026-01-01T00:00:00.000Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}

Delete a user given its identifier

delete

Paramètres de chemin

userstringRequis

Paramètres de requête

send_legal_noticebooleanOptionnel

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

no_mailbooleanOptionnel

Do not send the simple deletion notification email. Note: automatically set to True when send_legal_notice=True to avoid sending duplicate emails.

delete_commentsbooleanOptionnel

Delete comments posted by the user upon user deletion

Réponses

204

Object deleted

Aucun contenu

403

When trying to delete yourself

404

User not found

410

User is not active or has been deleted

delete/users/{user}/

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

Aucun contenu

Upload a new avatar for a given user

post

Paramètres de chemin

userstringRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

filestringRequis

The image to upload

bboxstringOptionnel

An optional crop box, as left,upper,right,lower pixel coordinates

Réponses

200

Success

application/json

imagestringOptionnel

successbooleanLecture seuleOptionnel

Whether the upload succeeded or not.

Default: true

post/users/{user}/avatar

POST /api/1/users/{user}/avatar HTTP/1.1
Host: www.data.gouv.fr
Content-Type: multipart/form-data
Accept: */*
Content-Length: 29

{
  "file": "text",
  "bbox": "text"
}

200

Success

{
  "image": "text",
  "success": true
}