SKskyfire

Get Agent Group

Changed on

As an Organization Admin, fetch one of your organization's agent groups by id.

get/api/v1/agent-groups/{agentGroupId}

Request

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

Path parameters

agentGroupIdstring uuid required

Unique identifier of the agent group. e.g. "215f6804-cd50-4c42-9c14-98db7312718d"

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.

createdAtstring required

When the group was created.

updatedAtstring required

When the group was last changed.

Changes