younifyd
Menu

List Available Agents

List Available Agents

GET/api/v2/groups/available_agents

Use it in a workflow

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

Request

Query parameters

pageobject

Cursor-based pagination parameters (JSON:API style). Supports nested parameters: - `page[size]` - Number of records per page (default varies by endpoint, typically 100) - `page[after]` - Cursor token to fetch records after this position - `page[before]` - Cursor token to fetch records before this position Example: `?page[size]=50&page[after]=eyJvIjoiaWQiLCJ2IjoiYVFFPSJ9`

afterstring

Cursor token for fetching next page

beforestring

Cursor token for fetching previous page

sizeinteger

Number of records per page

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 a any. Read it in later steps with {{listAvailableAgents.response.data.<field>}}.

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

List Available Agents — Zendesk — Documentation