authenticated
agents

Read Selectable Agents V2

V2 agents in the user's org. Not deleted; paused agents excluded unless include_paused is set. No has-engagements filter — a freshly created agent must be selectable before its first engagement.

Assignment dropdowns use the default (runnable agents only); the agents management page passes include_paused=true to list and unpause them.

get/agents/selectable-agents-v2

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

include_pausedboolean

Headers

organization-idstring nullable
x-user-idstring nullable
timezonestring
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

idstring required
namestring required
is_pausedboolean required
voice_enabledboolean required
roster_namestring nullable
has_channelboolean

Changes

No recorded changes to this operation across all 1 revision of this API.