users

User related operations

List all users

GET//www.data.gouv.fr/api/1/users/

Query parameters

Header parameters

Response

200

Success

Body

application/json

dataarray of User (object)

The page data

next_pagestring

The next page URL if exists

page*integer

The current page

page_size*integer

The page size used for pagination

previous_pagestring

The previous page URL if exists

total*integer

The total paginated items

Request

JavaScriptCurl

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

Response

{
  "data": [
    {
      "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-05-09T19:46:45.057Z",
      "slug": "text",
      "uri": "text",
      "website": "text"
    }
  ],
  "next_page": "text",
  "previous_page": "text"
}

Create a new object

POST//www.data.gouv.fr/api/1/users/

Header parameters

Body

application/json

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

Response

201400

Success

Body

application/json

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

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/users/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "first_name": "text",
      "id": "text",
      "last_name": "text",
      "since": "2024-05-09T19:46:45.057Z",
      "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-05-09T19:46:45.057Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}

List all possible user roles

GET//www.data.gouv.fr/api/1/users/roles/

Header parameters

Response

200

Success

Body

application/json

namestring

The role name

Request

JavaScriptCurl

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

Response

[
  {
    "name": "text"
  }
]

Suggest users

GET//www.data.gouv.fr/api/1/users/suggest/

Query parameters

Header parameters

Response

200

Success

Body

application/json

avatar_urlstring

The user avatar URL

first_namestring

The user first name

idstring

The user identifier

last_namestring

The user last name

slugstring

The user permalink string

Request

JavaScriptCurl

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

Response

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

List all followers for a given object

GET//www.data.gouv.fr/api/1/users/{id}/followers/

Path parameters

id*string

Query parameters

Header parameters

Response

200

Success

Body

application/json

dataarray of Follow (object)

The page data

next_pagestring

The next page URL if exists

page*integer

The current page

page_size*integer

The page size used for pagination

previous_pagestring

The previous page URL if exists

total*integer

The total paginated items

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/users/{id}/followers/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": "2024-05-09T19:46:45.057Z"
    }
  ],
  "next_page": "text",
  "previous_page": "text"
}

Follow a user given its ID

POST//www.data.gouv.fr/api/1/users/{id}/followers/

Path parameters

id*string

Response

403

When trying to follow yourself

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/users/{id}/followers/', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Unfollow an object given its ID

Returns the number of followers left after the operation

DELETE//www.data.gouv.fr/api/1/users/{id}/followers/

Path parameters

id*string

Response

200

Success

Request

JavaScriptCurl

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

Get a user given its identifier

GET//www.data.gouv.fr/api/1/users/{user}/

Path parameters

user*string

Header parameters

Response

200404410

Success

Body

application/json

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

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/users/{user}/', {
    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-05-09T19:46:45.057Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}

Update a user given its identifier

PUT//www.data.gouv.fr/api/1/users/{user}/

Path parameters

user*string

Header parameters

Body

application/json

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

Response

200400404410

Success

Body

application/json

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

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/users/{user}/', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "first_name": "text",
      "id": "text",
      "last_name": "text",
      "since": "2024-05-09T19:46:45.057Z",
      "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-05-09T19:46:45.057Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}

Delete a user given its identifier

DELETE//www.data.gouv.fr/api/1/users/{user}/

Path parameters

user*string

Response

204403404410

Object deleted

Request

JavaScriptCurl

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

Upload a new avatar for a given user

POST//www.data.gouv.fr/api/1/users/{user}/avatar

Path parameters

user*string

Header parameters

Body

multipart/form-data

filestring (binary)

bboxstring

Response

200

Success

Body

application/json

imagestring

successboolean

Whether the upload succeeded or not.

Request

JavaScriptCurl

const response = await fetch('//www.data.gouv.fr/api/1/users/{user}/avatar', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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