Get Agent Group Agents

As an Organization Admin, list the members of one of your organization's agent groups, one entry per enrolled user.

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.

The group is resolved within your own organization; a group that does not exist or belongs to another organization returns 404.

Current and former members

By default only currently enrolled users are returned. Pass includeUnenrolled=true to also return users who have been unenrolled. Their entries have enrolled: false and an unenrolledAt timestamp, and their deactivated instance's agentId is still listed, so its wallet stays reachable for fund recovery.

Agent status

agentActive is the instance's own flag, which is false once the user is unenrolled. status says whether the instance can transact right now:

statusMeaning
activeThe instance is active and the group is active.
inactiveThe instance is deactivated, which for a group instance means unenrolled.
group_inactiveThe instance is active but the group is deactivated, so it cannot mint.

Pagination

Members are ordered by enrollment time ascending and paginated by cursor. The response body is a plain array.

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

Link: <https://api.skyfire.xyz/api/v1/agent-groups/215f6804-…/agents?pageCursor=…>; 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.

Path Params
uuid
required

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

Query Params
boolean

Also return users who have been unenrolled. Defaults to false.

integer
1 to 1000

Maximum number of members 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