OAuth Clients

List Clients

Pagination

  • Cursor pagination (recommended)
  • Offset pagination

See Pagination.

Returns a maximum of 100 records per page.

Allowed For

  • Admins
get/api/v2/oauth/clients

Query parameters

page[before]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[after]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[size]integer

Specifies how many records should be returned in the response. You can specify up to 100 records per page.

Response

Success response

Example response

{
  "clients": [
    {
      "company": "Zendesk",
      "created_at": "2009-05-13T00:07:08Z",
      "description": "Zendesk Test Client",
      "id": 1,
      "identifier": "test_client",
      "name": "My Test Client",
      "redirect_uri": [
        "https://example.com/callback"
      ],
      "secret": "af3t24tfj34h43s...",
      "updated_at": "2011-07-22T00:11:12Z",
      "url": "https://example.zendesk.com/api/v2/clients/1.json",
      "user_id": 29
    }
  ]
}

Changes