SKskyfire

Get Agent Groups

Changed on

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

get/api/v1/agent-groups

Request

  • Base URL
    https://api.skyfire.xyz
  • URL
    https://api.skyfire.xyz/api/v1/agent-groups
  • Auth
    API key in header skyfire-api-key

Query parameters

includeInactiveboolean

Also return deactivated groups. Defaults to false.

pageSizeinteger

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

pageCursorstring

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

Response

Ok

idstring required

Unique identifier of the agent group.

namestring required

The group's name.

descriptionstring nullable required

The group's description, or null.

activeboolean required

Whether the group is active. Inactive groups appear only with includeInactive=true.

createdAtstring required

When the group was created.

updatedAtstring required

When the group was last changed.

Changes