Agents

List agents

Retrieves a paginated list of agents in your organization.

get/api/v2/agents

Request

Query parameters

pageSizeinteger

Maximum number of records to return. When omitted or set to 0, the default page size (100) applies. Values above 100 are treated as 100.

pageTokenstring

Opaque cursor from a previous response's nextPageToken. Must be used with the same pageSize. When omitted, results start at the beginning of the collection.

filterstring[]

A filter to apply to the query. Repeat the filter parameter for multiple clauses. Each value is one clause of the form <field>:<operator>:<value>.

For the in operator, join values with commas. Percent-encode those commas as %2C when constructing the query string so they remain part of one clause.

Supported fields include state, name, and email. Supported operators include eq, ne, search, and in.

EX: filter=state:eq:suspended

EX: filter=email:in:alpha@example.com%2Cbeta@example.com

EX: filter=state:eq:active&filter=name:search:bot

sortstring[]

The comma separated fields used to sort the collection. Default sort is ascending; prefix with - to sort descending. Supported fields include name, email, and state.

fieldsstring[]

The comma separated fields included in the returned records. If omitted, the default list of fields is returned.

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Response

Agents retrieved successfully

totalSizeinteger

Total number of agents matching the request after filters are applied.

nextPageTokenstring

Opaque cursor for the next page. Omitted when there is no subsequent page.

Changes

No recorded changes to this operation across all 1 revision of this API.