users

User related operations

List all users

get
Query parameters
qanyoptional

The search query

sortanyoptional

The field (and direction) on which sorting apply

pageanyoptional

The page to display

page_sizeanyoptional

The page size

Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
application/json
objectoptional
get
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",
      "email": {},
      "first_name": "text",
      "id": "text",
      "last_login_at": {},
      "last_name": "text",
      "metrics": {},
      "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": "2025-04-17T12:35:51.582Z",
      "slug": "text",
      "uri": "text",
      "website": "text"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Create a new object

post
Header parameters
X-Fieldsanyoptional

An optional fields mask

Body
aboutstring · markdownoptional

The user self description

activebooleanoptional
avatarstringoptional

The user avatar URL

avatar_thumbnailstringoptional

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

emailobjectread-onlyoptional

The user email

first_namestringrequired

The user first name

idstringrequired

The user identifier

last_login_atobjectread-onlyoptional

The user last connection date (only present for global admins and on /me)

last_namestringrequired

The user last name

metricsobjectread-onlyoptional

The user metrics

organizationsall of[]optional

The organization the user belongs to

pagestringread-onlyoptional

The user profile page URL

rolesstring[]optional

Site wide user roles

sincestring · date-timerequired

The registeration date

slugstringrequired

The user permalink string

uristringrequired

The user API URI

websitestringoptional

The user website

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

{
  "about": "text",
  "active": true,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "first_name": "text",
  "id": "text",
  "last_name": "text",
  "organizations": [
    {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "logo": "text",
      "logo_thumbnail": "text",
      "slug": "text"
    }
  ],
  "roles": [
    "text"
  ],
  "since": "2025-04-17T12:35:51.582Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}
{
  "about": "text",
  "active": true,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "email": {},
  "first_name": "text",
  "id": "text",
  "last_login_at": {},
  "last_name": "text",
  "metrics": {},
  "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": "2025-04-17T12:35:51.582Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}

List all possible user roles

get
Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
application/json
object[]optional
get
GET /api/1/users/roles/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

[
  {
    "name": "text"
  }
]

Suggest users

get
Query parameters
qanyrequired

The string to autocomplete/suggest

sizeanyoptional

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

Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
application/json
object[]optional
get
GET /api/1/users/suggest/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

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

List all followers for a given object

get
Path parameters
idanyrequired
Query parameters
pageanyoptional

The page to fetch

page_sizeanyoptional

The page size to fetch

Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
application/json
objectoptional
get
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",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "id": "text",
      "since": "2025-04-17T12:35:51.582Z"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Follow a user given its ID

post
Path parameters
idanyrequired
Responses
post
POST /api/1/users/{id}/followers/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
403

When trying to follow yourself

No Content

Unfollow an object given its ID

delete

Returns the number of followers left after the operation

Path parameters
idanyrequired
Responses
delete
DELETE /api/1/users/{id}/followers/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

No Content

Get a user given its identifier

get
Path parameters
useranyrequired
Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
application/json
objectoptional
get
GET /api/1/users/{user}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
{
  "about": "text",
  "active": true,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "email": {},
  "first_name": "text",
  "id": "text",
  "last_login_at": {},
  "last_name": "text",
  "metrics": {},
  "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": "2025-04-17T12:35:51.582Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}

Update a user given its identifier

put
Path parameters
useranyrequired
Header parameters
X-Fieldsanyoptional

An optional fields mask

Body
aboutstring · markdownoptional

The user self description

activebooleanoptional
avatarstringoptional

The user avatar URL

avatar_thumbnailstringoptional

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

emailobjectread-onlyoptional

The user email

first_namestringrequired

The user first name

idstringrequired

The user identifier

last_login_atobjectread-onlyoptional

The user last connection date (only present for global admins and on /me)

last_namestringrequired

The user last name

metricsobjectread-onlyoptional

The user metrics

organizationsall of[]optional

The organization the user belongs to

pagestringread-onlyoptional

The user profile page URL

rolesstring[]optional

Site wide user roles

sincestring · date-timerequired

The registeration date

slugstringrequired

The user permalink string

uristringrequired

The user API URI

websitestringoptional

The user website

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

{
  "about": "text",
  "active": true,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "first_name": "text",
  "id": "text",
  "last_name": "text",
  "organizations": [
    {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "logo": "text",
      "logo_thumbnail": "text",
      "slug": "text"
    }
  ],
  "roles": [
    "text"
  ],
  "since": "2025-04-17T12:35:51.582Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}
{
  "about": "text",
  "active": true,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "email": {},
  "first_name": "text",
  "id": "text",
  "last_login_at": {},
  "last_name": "text",
  "metrics": {},
  "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": "2025-04-17T12:35:51.582Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}

Delete a user given its identifier

delete
Path parameters
useranyrequired
Query parameters
no_mailanyoptional

Do not send a mail to notify the user of the deletion

delete_commentsanyoptional

Delete comments posted by the user upon user deletion

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

No Content

Dernière mise à jour

Cet article vous a-t-il été utile ?