/

Docs
History
Schema
Generate

Filter operations

Accesskey5

Activeflow5

Agent11

AI46

Auth10

Billing12

Call24

Campaign14

Case12

Conference14

Contact17

Conversation11

Customer13

Email4

Extension8

Flow7

Groupcall5

Interaction2

Me1

Message4

Number9

NumberProvider5

Outdial11

Outplan6

Provider6

ProviderCall4

Queue13

RAG7

Recording7

Route5

Service Agent84

get/service_agents/agents/{id}Retrieve detailed information of a service agent
get/service_agents/agentsRetrieve a list of service agents
get/service_agents/aicallsList aicalls
post/service_agents/aicallsCreate an aicall
post/service_agents/aicalls/{id}/listenStart listening to the linked live call
get/service_agents/aimessagesList aimessages for an aicall
post/service_agents/aimessagesSend an aimessage
post/service_agents/aimessages/draft-decisionDecide a draft
get/service_agents/calls/{id}Retrieve detailed information of a specific call
post/service_agents/calls/{id}/participantsAdd a participant to a call
get/service_agents/calls/{id}/queuecallGet the queue of a call
post/service_agents/calls/{id}/recording_startStart recording a call
post/service_agents/calls/{id}/recording_stopStop recording a call
get/service_agents/callsRetrieve a list of calls for the given customer
get/service_agents/conversations/{id}/messagesGet list of conversation messages
post/service_agents/conversations/{id}/messagesSend a message to the conversation
post/service_agents/conversations/{id}/unassignUnassign the conversation
get/service_agents/conversations/{id}Get detailed conversation info
put/service_agents/conversations/{id}Update conversation info
get/service_agents/conversationsGet list of conversations
post/service_agents/contact_cases/{id}/closeClose the case
post/service_agents/contact_cases/{id}/assignAssign the case to an owner agent
post/service_agents/contact_cases/{id}/unassignUnassign the case
get/service_agents/contact_cases/{id}/notesList notes for a case
post/service_agents/contact_cases/{id}/notesCreate a note on a case
delete/service_agents/contact_cases/{id}/notes/{note_id}Delete a case note
get/service_agents/contact_cases/{id}Get detailed case info
put/service_agents/contact_cases/{id}Attach or detach a case's contact
get/service_agents/contact_casesGet list of contact cases
get/service_agents/customerGet customer details
get/service_agents/extensions/{id}Get extension details
get/service_agents/extensionsGet list of extensions
get/service_agents/files/{id}Get file details
delete/service_agents/files/{id}Delete a file
get/service_agents/files/{id}/fileDownload the service agent file
get/service_agents/filesGet list of files
post/service_agents/filesUpload a file
put/service_agents/me/addressesUpdate authenticated agent's addresses
put/service_agents/me/passwordUpdate authenticated agent's password
put/service_agents/me/statusUpdate authenticated agent's status
get/service_agents/meGet authenticated agent's details
put/service_agents/meUpdate authenticated agent's information
get/service_agents/wsEstablish a WebSocket connection
delete/service_agents/talk_chats/{id}/participants/{participant_id}Remove a participant from a talk chat
get/service_agents/talk_chats/{id}/participantsGet participants of a talk chat
post/service_agents/talk_chats/{id}/participantsAdd a participant to a talk chat
post/service_agents/talk_chats/{id}/joinJoin a talk chat
post/service_agents/transfersStart a transfer
get/service_agents/talk_chats/{id}Get talk chat by ID
put/service_agents/talk_chats/{id}Update talk chat
delete/service_agents/talk_chats/{id}Delete talk chat
get/service_agents/talk_chatsGet list of talk chats
post/service_agents/talk_chatsCreate a new talk chat
get/service_agents/talk_channelsGet list of public talk channels
get/service_agents/talk_mentionsGet list of talk messages that mention the calling agent
post/service_agents/talk_messages/{id}/reactionsAdd a reaction to a talk message
get/service_agents/talk_messages/{id}Get talk message by ID
delete/service_agents/talk_messages/{id}Delete talk message
get/service_agents/talk_messagesGet list of talk messages for a specific chat
post/service_agents/talk_messagesCreate a new talk message
delete/service_agents/talk_pins/{id}Remove a pin
get/service_agents/talk_pinsGet a list of the pins of the calling agent
post/service_agents/talk_pinsPin a chat or a message
get/service_agents/contacts/{id}/case_notesGet list of case notes of a contact
put/service_agents/contacts/{id}/starStar a contact
delete/service_agents/contacts/{id}/starRemove the star of a contact
delete/service_agents/push_devices/{id}Delete a push device
post/service_agents/push_devicesRegister a push device
delete/service_agents/contacts/{id}/tags/{tag_id}Remove tag from contact
post/service_agents/contacts/{id}/tagsAdd tag to contact
get/service_agents/contacts/{id}Get the contact
put/service_agents/contacts/{id}Update a contact
delete/service_agents/contacts/{id}Delete the contact
get/service_agents/contacts/lookupLookup contact
get/service_agents/contactsList contacts
post/service_agents/contactsCreate a new contact
get/service_agents/contact_starsList the contacts starred by the calling agent
get/service_agents/tags/{id}Retrieve detailed information of a tag
get/service_agents/tagsRetrieve a list of tags
get/service_agents/contact_interactionsList interactions
get/service_agents/contact_peer_eventsList peer_events (raw, unfiltered)
get/service_agents/transcribesList transcribes
post/service_agents/transcribesStart a transcribe
get/service_agents/transcriptsList transcript lines

ServiceAgent9

ServiceConfig4

Speaking7

Storage10

Tag5

Team6

Timeline8

Transcribe6

Transfer1

Trunk5

Webchat15

Websocket1

Service Agent

Changes to Register a push device

post/service_agents/push_devices

Nov 9, 2026dc2b59b1d86c Revision changes
- info
  endpoint added