users

User related operations

Précédentspatial Suivantme

Dernière mise à jour il y a 1 an

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

List all possible user roles

get

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://www.data.gouv.fr/api/1/users/roles/'

200

[
  {
    "name": "text"
  }
]

Success

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

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://www.data.gouv.fr/api/1/users/suggest/'

200

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

Success

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

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://www.data.gouv.fr/api/1/users/{id}/followers/'

200

{
  "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-03-25T05:00:16.425Z"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Success

Follow a user given its ID

post

Path parameters

idanyrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/users/{id}/followers/'

403

No body

When trying to follow yourself

Unfollow an object given its ID

delete

Returns the number of followers left after the operation

Path parameters

idanyrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://www.data.gouv.fr/api/1/users/{id}/followers/'

200

No body

Success

Get a user given its identifier

get

Path parameters

useranyrequired

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://www.data.gouv.fr/api/1/users/{user}/'

200

404

410

{
  "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-03-25T05:00:16.425Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}

Success

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://www.data.gouv.fr/api/1/users/{user}/'

204

403

404

410

No body

Object deleted

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

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://www.data.gouv.fr/api/1/users/'

200

{
  "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-03-25T05:00:16.425Z",
      "slug": "text",
      "uri": "text",
      "website": "text"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Success

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/users/' \
  --header 'Content-Type: application/json' \
  --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"
      }
    ],
    "roles": [
      "text"
    ],
    "since": "2025-03-25T05:00:16.425Z",
    "slug": "text",
    "uri": "text",
    "website": "text"
  }'

201

400

{
  "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-03-25T05:00:16.425Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}

Success

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://www.data.gouv.fr/api/1/users/{user}/' \
  --header 'Content-Type: application/json' \
  --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"
      }
    ],
    "roles": [
      "text"
    ],
    "since": "2025-03-25T05:00:16.425Z",
    "slug": "text",
    "uri": "text",
    "website": "text"
  }'

200

400

404

410

{
  "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-03-25T05:00:16.425Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}

Success

List all possible user roles

Suggest users

List all followers for a given object

Follow a user given its ID

Unfollow an object given its ID

Get a user given its identifier

Delete a user given its identifier

List all users

Create a new object

Show all of

Update a user given its identifier

Show all of