Sign in
Groups

List Groups

Pagination

  • Cursor pagination (recommended)
  • Offset pagination

See Pagination.

Returns a maximum of 100 records per page.

Allowed For

  • Admins
  • Agents
get/api/v2/groups

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.

exclude_deletedboolean

Whether to exclude deleted entities

Response

Success response

Example response

{
  "groups": [
    {
      "created_at": "2009-07-20T22:55:29Z",
      "default": true,
      "deleted": false,
      "description": "Some clever description here",
      "id": 3432,
      "is_public": true,
      "name": "First Level Support",
      "updated_at": "2011-05-05T10:38:52Z",
      "url": "https://company.zendesk.com/api/v2/groups/3432.json"
    }
  ]
}

Changes