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 users

get

/users/

Query parameters

qstring

The search query

sortstring · enum

The field (and direction) on which sorting apply

Options: last_name, first_name, datasets, reuses, followers, views, created, -last_name, -first_name, -datasets, -reuses, -followers, -views, -created

pageinteger · default: 1

The page to display

page_sizeinteger · default: 20

The page size

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1,
  "data": [
    {
      "about": "text",
      "active": true,
      "avatar": "text",
      "avatar_thumbnail": "text",
      "email": {},
      "first_name": "text",
      "id": "text",
      "last_name": "text",
      "metrics": {},
      "page": "text",
      "since": "2025-02-20T19:07:49.850Z",
      "slug": "text",
      "uri": "text",
      "website": "text",
      "organizations": [
        {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text",
          "badges": [
            {
              "kind": "text"
            }
          ]
        }
      ],
      "roles": [
        "text"
      ]
    }
  ]
}

Success

Create a new object

post

/users/

Header parameters

X-Fieldsstring · mask

An optional fields mask

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_namestringrequired

The user first name

idstringrequired

The user identifier

last_namestringrequired

The user last name

metricsobject

The user metrics

pagestring

The user profile page URL

sincestring · date-timerequired

The registeration date

slugstringrequired

The user permalink string

uristringrequired

The user API URI

websitestring

The user website

organizationsall of[]

The organization the user belongs to

rolesstring[]

Site wide user roles

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/users/' \
  --header 'Content-Type: application/json' \
  --data '{"email":{},"first_name":"text","id":"text","last_name":"text","metrics":{},"since":"2025-02-20T19:07:49.850Z","slug":"text","uri":"text","organizations":[{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]}],"roles":[null]}'

201

400

{
  "about": "text",
  "active": true,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "email": {},
  "first_name": "text",
  "id": "text",
  "last_name": "text",
  "metrics": {},
  "page": "text",
  "since": "2025-02-20T19:07:49.850Z",
  "slug": "text",
  "uri": "text",
  "website": "text",
  "organizations": [
    {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text",
      "badges": [
        {
          "kind": "text"
        }
      ]
    }
  ],
  "roles": [
    "text"
  ]
}

Success

List all possible user roles

get

/users/roles/

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

[
  {
    "name": "text"
  }
]

Success

Suggest users

get

/users/suggest/

Query parameters

qstringrequired

The string to autocomplete/suggest

sizestring · default: 10

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

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//www.data.gouv.fr/api/1/users/suggest/?q=text'

200

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

Success

List all followers for a given object

get

/users/{id}/followers/

Path parameters

idstringrequired

Query parameters

pageinteger · default: 1

The page to fetch

page_sizeinteger · default: 20

The page size to fetch

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1,
  "data": [
    {
      "id": "text",
      "since": "2025-02-20T19:07:49.850Z",
      "follower": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ]
}

Success

Follow a user given its ID

post

/users/{id}/followers/

Path parameters

idstringrequired

Responses

cURL

JavaScript

Python

HTTP

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

403

No body

When trying to follow yourself

Unfollow an object given its ID

Returns the number of followers left after the operation

delete

/users/{id}/followers/

Path parameters

idstringrequired

Responses

cURL

JavaScript

Python

HTTP

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

200

No body

Success

Get a user given its identifier

get

/users/{user}//

Path parameters

userstringrequired

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '//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_name": "text",
  "metrics": {},
  "page": "text",
  "since": "2025-02-20T19:07:49.850Z",
  "slug": "text",
  "uri": "text",
  "website": "text",
  "organizations": [
    {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text",
      "badges": [
        {
          "kind": "text"
        }
      ]
    }
  ],
  "roles": [
    "text"
  ]
}

Success

Update a user given its identifier

put

/users/{user}//

Path parameters

userstringrequired

Header parameters

X-Fieldsstring · mask

An optional fields mask

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_namestringrequired

The user first name

idstringrequired

The user identifier

last_namestringrequired

The user last name

metricsobject

The user metrics

pagestring

The user profile page URL

sincestring · date-timerequired

The registeration date

slugstringrequired

The user permalink string

uristringrequired

The user API URI

websitestring

The user website

organizationsall of[]

The organization the user belongs to

rolesstring[]

Site wide user roles

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '//www.data.gouv.fr/api/1/users/{user}/' \
  --header 'Content-Type: application/json' \
  --data '{"email":{},"first_name":"text","id":"text","last_name":"text","metrics":{},"since":"2025-02-20T19:07:49.850Z","slug":"text","uri":"text","organizations":[{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]}],"roles":[null]}'

200

400

404

410

{
  "about": "text",
  "active": true,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "email": {},
  "first_name": "text",
  "id": "text",
  "last_name": "text",
  "metrics": {},
  "page": "text",
  "since": "2025-02-20T19:07:49.850Z",
  "slug": "text",
  "uri": "text",
  "website": "text",
  "organizations": [
    {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text",
      "badges": [
        {
          "kind": "text"
        }
      ]
    }
  ],
  "roles": [
    "text"
  ]
}

Success

Delete a user given its identifier

delete

/users/{user}//

Path parameters

userstringrequired

Query parameters

no_mailboolean

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

Responses

cURL

JavaScript

Python

HTTP

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

204

403

404

410

No body

Object deleted