listAiCoworkers

View as Markdown

List AI Coworkers accessible to the current user.

Lists AI Coworkers. Behavior depends on the caller’s role:

  • Admin (MANAGE_AGENT_SETTINGS): returns all agents regardless of publish_state or availability_status. Use this to manage the full agent inventory.

Parameters

NameTypeRequiredDescription
agent_typeAiAgentTypeEnum[]NoFilter by agent type. The server clamps results to [SYSTEM, CUSTOM] on this
agent_subtypeAiAgentSubtypeEnumNoFilter by agent subtype label. Omit to return agents of any subtype.
workspace_idintegerNoFilter to agents whose linked AI_EMPLOYEE user is a member of the given workspace.
pageintegerNoPage number for pagination Default: 1.
per_pageintegerNoNumber of items per page Default: 25.
sort_byAiAgentSortByEnumNoSort order for the returned page. Defaults to UPDATED_AT_DESC (most-recently-updated first) when omitted.
publish_stateAgentPublishStateFilterEnum[]NoFilter by publish state. Comma-separated list of values narrows results to agents