GET /api/v2/groups/available_agents

Returns a list of all agents available to be added to groups. The current user must have permission to edit group memberships.

Pagination

Cursor pagination

See Pagination.

Returns a maximum of 1000 records per page.

Allowed For

Admins
Agents with permission to edit group memberships

Servers

https://{subdomain}.{domain}.com

Query parameters

Name	Type	Required	Description
`page`	Object	No	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`
`include_boundary_indicators`	Boolean	No	When true, includes `has_more` indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]).
`sort`	String	No	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_item_cursors`	Boolean	No	When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]).

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.