users

List all users

get/admin/v1/users

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /admin/v1/users
  • Auth: HTTP bearer

Query parameters

limitinteger nullable

Maximum number of results to return

cursorstring nullable

Cursor for keyset pagination. Encoded as base64 string.

directionstring nullable

Pagination direction: "forward" (default) or "backward".

include_deletedboolean nullable

Include soft-deleted records in results

Response

List of users

Example response

{
  "pagination": {
    "has_more": true,
    "limit": 100,
    "next_cursor": "MTczMzU4MDgwMDAwMDphYmMxMjM0NS02Nzg5LTAxMjMtNDU2Ny0wMTIzNDU2Nzg5YWI"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.