Sign in
users

List users

Returns a paginated list of client users.

get/users

Query parameters

limitnumber

The number of items to return

Example:20
cursorstring cuid

The cursor to return the next page of items

Example:cmf41ajzv003706un4i99q19z

Headers

x-client-idstring cuid required

The ID of the client

Example:cmf41ajzv003706un4i99q19z

Response

Users

Example response

{
  "data": [
    {
      "id": "cmf41ajzv003706un4i99q1a0",
      "createdAt": "2024-05-14T08:30:00Z",
      "email": "frida@example.com",
      "firstName": "Frida",
      "lastName": "Meyer",
      "roles": [
        "client_admin"
      ]
    }
  ],
  "pagination": {
    "nextCursor": "cmf41ajzv003706un4i99q19z",
    "previousCursor": "cmf41ajzv003706un4i99q19z",
    "limit": 20,
    "total": 134
  }
}

Changes

Changed in 1 of the 5 revisions of this API.1

  • 80748f72965e1See the full diff
    • ○

      added the media type application/json for the response with the status 500

      response-media-type-added