latestOpenAPI 3.1.02026-08-13233474.8 KB

e920ac8ed225

Agents

Get Agents

Get a list of agents scoped by the query parameters.

get/agents

Query parameters

idstring

Agent ID.

Agent ID.

groupIdstring

The ID of the Group the agent belongs to.

The ID of the Group the agent belongs to.

cursorstring

Cursor for start of next set of items. Pass whatever you receive from the response to get the next elements in the array.

Cursor for start of next set of items. Pass whatever you receive from the response to get the next elements in the array.

limitnumber

Limit of items per page.

Limit of items per page.

Response

Returns a list of agents that match the query parameters.

cursorstring nullable required

Cursor for start of next set of items. If there were no items to return with the last cursor you passed, this will return null.

hasMoreboolean required

Whether there are more items to load past this cursor.