younifyd
Menu

List Groups

List Groups

GET/api/v2/groups

Use it in a workflow

  1. Add a step and choose the Zendesk connector.
  2. Pick the List Groups action (under Groups).
  3. Fill in the fields below, then reference the result from later steps as {{listGroups.response.data}}.

Request

Query parameters

exclude_deletedboolean

Whether to exclude deleted entities

includestring

Sideloads to include in the response. Accepts a comma-separated list of values.

pageoneOf

Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.

per_pageinteger

Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.

sortstring

Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at`

include_boundary_indicatorsboolean

When true, includes `has_more` indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]).

include_item_cursorsboolean

When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]).

Response

Returns 200 with an object. Read it in later steps with {{listGroups.response.data.<field>}}.

groupsarray<object>
created_atstring (date-time)

The time the group was created

defaultboolean

If the group is the default one for the account

deletedboolean

Deleted groups get marked as such

descriptionstring

The description of the group

idinteger (int64)

Automatically assigned when creating groups

is_publicboolean

If true, the group is public. If false, the group is private. You can't change a private group to a public group

namestringrequired

The name of the group

updated_atstring (date-time)

The time of the last update of the group

urlstring

The API url of the group

json
{
  "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"
    }
  ]
}

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.