BEbetagouv
Admin

Get Users

Changed on
get/v1/admin/users

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Query parameters

role_idinteger nullable

The ID of the role to filter the users by.

organization_idinteger nullable

The ID of the organization to filter the users by.

emailstring nullable

Email substring to filter the users by.

offsetinteger

Number of users to skip.

limitinteger

Maximum number of users to return.

sort_by'id' | 'email' | 'created' | 'updated'

Field to sort by.

sort_order'asc' | 'desc'

Sort order.

Response

Successful Response

object'list'

Type of the object.

totalinteger required

Total number of users matching the query.

offsetinteger required

Number of users skipped.

limitinteger required

Maximum number of users returned.

Changes