Get Agent Group Agents

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

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

Request

agentGroupIdstring uuid required

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

includeUnenrolledboolean

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

pageSizeinteger

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

userIdstring required

The enrolled organization user.

agentIdstring required

The user's instance of the group: a buyer agent. Use it with the agent, card, and wallet endpoints.

displayNamestring required

The instance's display name, which is the group's name.

agentActiveboolean required

The instance's own active flag. false once the user is unenrolled.

status'active' | 'inactive' | 'group_inactive' required

Whether the instance can transact. group_inactive means the instance is active but the group is deactivated.

enrolledboolean required

false once the user has been unenrolled.

enrolledAtstring required

When the user was enrolled.

unenrolledAtstring nullable required

When the user was unenrolled, or null while enrolled.