Users

List users

Changed on

Retrieve a paginated list of users in the environment. Defaults to 50 users per page.

get/v1/users

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/users
  • Auth: HTTP bearer

Query parameters

includestring[]

Associated resources to include in the response.

order'asc' | 'desc'

Sort by insertion order. Pass asc for oldest first, or desc for newest first. Defaults to oldest first when omitted.

afterstring

The cursor to fetch entries after.

beforestring

The cursor to fetch entries before.

page_sizeinteger

The number of items per page (defaults to 50).

Response

OK

Example response

{
  "entries": [
    {
      "__typename": "User",
      "created_at": null,
      "email": "ian.malcolm@chaos.theory",
      "id": "user_id",
      "name": "Dr. Ian Malcolm",
      "updated_at": "2024-05-22T12:00:00Z"
    }
  ],
  "page_info": {
    "__typename": "PageInfo",
    "after": null,
    "before": null,
    "page_size": 25
  }
}

Changes