Agent Workflow15

Agents11

Alerts6

Aligned Diff1

Amelia4

BBB2

bland4

Bluejay as Code2

BluejayAI References2

Call Logs9

Communities7

Custom Metric Templates8

Custom Metrics21

Customer Personas5

Customer Traits6

Dashboards9

Digital Humans21

Documents6

ElevenLabs6

Evaluate2

Folders7

Goals1

google_agents3

google_ces2

google_dfcx1

HTTP Text Agent3

Human Edits12

Integration Keys5

Issues3

Journey Steps1

Knowledge Bases7

Labels5

Live Transcripts1

livekit1

Metrics Lab12

Metronome Webhook1

Observability Conversations2

oidc2

Optimize2

Phone Number Management3

Phone Numbers1

Preview Chat1

Prompts12

Queue Simulation Run1

Re-evaluate2

Red-Team Simulations4

Regeneration1

Rerun Simulation Results1

retell3

Retrieve Simulation Results2

Scenario Builder9

Self-Improve4

Simulation Results1

Simulation Runs2

Simulations10

Slack Assistant2

SMS Testing4

Subscription10

Text Simulations2

Traces3

Translation1

Twilio SIP Webhook1

Uptime10

Usage Alerts4

vapi8

Voice Clones4

Voice Generation1

Webhook Management4

Weekly notifications1

Widgets6

Workflow Extraction4

Workspaces11

Webhooks

postWebhook: events_webhook

Agents

Get Agent By External Id

Get an agent by external ID.

get/v1/agent-by-external-id/{external_id}

Path parameters

external_idstring required

Headers

X-API-Keystring required

API key required to authenticate requests.

Response

Successful Response

bluejay_as_code_idstring uuid nullable

namestring required

agent_descriptionstring required

organization_idstring required

workspace_idstring nullable

goalsstring[] nullable

mode'VOICE' | 'TEXT' required

Enum representing the mode of agent

type'INBOUND' | 'OUTBOUND'

Enum representing the type of agent

Enum representing the connection type of the agent

phone_numberstring nullable

follow_up_sms_sender_numbersstring[] nullable

websocket_urlstring nullable

redact_piiboolean nullable

folder_idstring uuid nullable

created_atstring date-time nullable

updated_atstring date-time nullable

updated_bystring uuid nullable

created_bystring uuid nullable

keytermsstring[] nullable

voice_providerstring nullable

provider_idstring nullable

websocket_usernamestring nullable

websocket_passwordstring nullable

external_agent_idstring nullable

sip_uristring nullable

custom_sip_headersobject nullable

sip_usernamestring nullable

sip_passwordstring nullable

simulation_notificationsobject

livekit_agent_namestring nullable

livekit_metadataobject nullable

livekit_customer_tool_topicstring nullable

livekit_token_webhook_urlstring nullable

livekit_token_webhook_authstring nullable

pipecat_agent_namestring nullable

pipecat_agent_configurationobject nullable

pipecat_room_propertiesobject nullable

http_webhookstring nullable

http_webhook_keystring nullable

dynamic_sip_webhook_urlstring nullable

outbound_trigger_webhook_urlstring nullable

outbound_trigger_payload_templateobject nullable

eleven_labs_agent_idstring nullable

retell_agent_idstring nullable

vapi_assistant_idstring nullable

ces_app_idstring nullable

ces_deployment_idstring nullable

dfcx_project_idstring nullable

dfcx_locationstring nullable

dfcx_agent_idstring nullable

amelia_base_urlstring nullable

amelia_domain_codestring nullable

amelia_flow_namestring nullable

amelia_agent_namestring nullable

bland_pathway_idstring nullable

bland_agent_idstring nullable

bland_persona_idstring nullable

kore_hoststring nullable

kore_bot_idstring nullable

kore_client_idstring nullable

kore_client_secretstring nullable

kore_inbound_tokenstring nullable

enable_outbound_call_auto_startboolean nullable

simulations_disabledboolean nullable

workflowobject nullable

Source platform the agent's definition (system prompt, workflow) comes from.

Distinct from voice_provider (TTS/STT vendor) and provider_id (handle on that vendor) — this identifies where the agent's behavior (prompt, multi-agent graph) is authored.

red_team_profileobject nullable

Changes

Changed in 6 of the 19 revisions of this API.915

Aug 27, 2026a52d6f90f25a11See the full diff
- ●
  added the new SIERRA_VOICE enum value to the connection_type/anyOf[subschema #1: ConnectionType]/ response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property workspace_id to the response with the 200 status
  response-optional-property-added
Aug 21, 2026b29e1840a3861See the full diff
- ○
  added the optional property livekit_token_webhook_auth to the response with the 200 status
  response-optional-property-added
Aug 8, 2026f48cef80963f1See the full diff
- ●
  added the new BLAND_PHONE enum value to the connection_type/anyOf[subschema #1: ConnectionType]/ response property for the response status 200
  response-property-enum-value-added
Aug 4, 202690ededf7fc7d33See the full diff
- ●
  added the new BLAND enum value to the provider/anyOf[subschema #1: Provider]/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new BLAND_CHAT enum value to the connection_type/anyOf[subschema #1: ConnectionType]/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new BLAND_VOICE enum value to the connection_type/anyOf[subschema #1: ConnectionType]/ response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property bland_agent_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property bland_pathway_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property bland_persona_id to the response with the 200 status
  response-optional-property-added
Jul 31, 20264309a961859b39See the full diff
- ●
  added the new AMELIA enum value to the provider/anyOf[subschema #1: Provider]/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new AMELIA_CHAT enum value to the connection_type/anyOf[subschema #1: ConnectionType]/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new AMELIA_VOICE enum value to the connection_type/anyOf[subschema #1: ConnectionType]/ response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property amelia_agent_name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property amelia_base_url to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property amelia_domain_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property amelia_flow_name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property created_by to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property outbound_trigger_payload_template to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property outbound_trigger_webhook_url to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property updated_at to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property updated_by to the response with the 200 status
  response-optional-property-added
Jul 26, 202644d183272ce111See the full diff
- ●
  removed the optional property knowledge_base from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property red_team_profile to the response with the 200 status
  response-optional-property-added
This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history