As an Organization Admin, list an organization user's agentswith their enrolled cards.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
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 user must belong to your organization and be active: an unknown user returns 404 and a deactivated user returns 400.
What is returned
Every agent the user holds, active or not, ordered by creation time: their ungrouped buyer, their seller agents, and their instance of each agent group they are or were enrolled in. The response is a plain array and is not paginated.
Pass agentGroupId to return only the user's instance of that group, which is a zero- or one-element array.
Group membership and status
| Field | Meaning |
|---|---|
agentGroupId | The group this agent is an instance of, or null for an ungrouped agent. Stays set after the user is unenrolled. |
active | The agent's own flag. false after deactivation or unenrollment. |
status | active, inactive, or group_inactive. The last means the agent is active but its group is deactivated. |
Ungrouped agents are changed with Update Organization User Agent. Grouped agents are changed through their group.
Cards
cards lists the agent's active Visa and Mastercard enrollments, oldest first, each with its id, network, and last four digits, and whether it is suspended. Seller agents and agents with no cards return an empty array. preferredCardId names the card used by default, or null when none is set or the preferred card is no longer enrolled.