Get Agent Groups

As an Organization Admin, list the agent groups in your organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401.

Only active groups are returned by default. Pass includeInactive=true to also return deactivated groups, which keep their members and can be reactivated with Update Agent Group.

Pagination

Results are ordered by creation time ascending and paginated by cursor. The response body is a plain array of groups.

When more results exist, the response carries a Link header pointing at the next page:

Link: <https://api.skyfire.xyz/api/v1/agent-groups?pageCursor=215f6804-…>; rel="next"

Take the pageCursor value from that URL and pass it back to fetch the following page. When no Link header is present, you have reached the last page.

pageSize defaults to 100 and may not exceed 1000. A pageCursor that was not returned by a previous page of the same listing returns 400.

Query Params
boolean

Also return deactivated groups. Defaults to false.

integer
1 to 1000

Maximum number of groups to return. Defaults to 100, at most 1000.

string

Cursor for the next page, taken from the pageCursor query parameter of the previous response's Link header.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json