SKskyfire

Get Organization User Agents

Changed on

As an Organization Admin, list an organization user's agentswith their enrolled cards.

get/api/v1/organizations/users/{userId}/agents

Request

  • Base URL
    https://api.skyfire.xyz
  • URL
    https://api.skyfire.xyz/api/v1/organizations/users/{userId}/agents
  • Auth
    API key in header skyfire-api-key

Path parameters

userIdstring uuid required

Unique identifier of the organization user. e.g. "906fc259-ef0a-4736-bdcd-c1d5a78db483"

Query parameters

agentGroupIdstring uuid

Only the user's instance of this agent group.

Response

Ok

agentIdstring required

Unique identifier of the agent.

displayNamestring required

The agent's display name. For a group instance, the group's name.

agentType'BUYER' | 'SELLER' required

Whether the agent buys or sells.

activeboolean required

The agent's own active flag.

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

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

agentGroupIdstring nullable required

The agent group this agent is an instance of, or null for an ungrouped agent.

preferredCardIdstring nullable required

The card used by default, or null.

Changes