agents

Get a specific agent by ID

Retrieves the full agent configuration including instructions, voice, evaluations, data collections, linked calendars, transfer numbers, and tasks. Use for edit form pre-population, detail views, or config audits. Returns 404 if the agent doesn't belong to the authenticated user or was soft-deleted.

get/agents/{id}

Request

Base URL: https://be.skipcalls.com (the document declares no server; this is the origin it was published from)
URL: https://be.skipcalls.com/agents/{id}
Auth: HTTP bearer

Path parameters

idstring required

Response

Returns the agent if found.

idstring required

namestring required

Agent name

descriptionstring

Agent description

avatarstring

Agent avatar

isPublicboolean required

Is agent public

isActiveboolean required

Is agent active

instructionsstring required

Agent instructions

incomingCallInstructionsstring required

Agent instructions for incoming calls

maxIncomingCallDurationMinutesnumber required

Max duration of incoming call in minutes

maxOutgoingCallDurationMinutesnumber required

Max duration of outgoing call in minutes

gatheringInformationOnIncomingCallboolean required

Whether the agent allows gathering information on incoming call

createdAtstring date-time required

Agent created at

updatedAtstring date-time required

Agent updated at

accessToKnowledgeboolean

Is agent allowed to access knowledge

knowledgeAccessMode'NONE' | 'ALL' | 'TAGS_ONLY'

Knowledge access mode for the agent

knowledgeAccessTagsstring[]

Tags that the agent has access to when knowledge access is tag-limited

allowFollowUpsboolean

Is agent allowed to schedule follow-ups

followUpInstructionsstring

Custom instructions for smart follow-up messages

includePrivateDataboolean

Whether the user's profile info (owner name, phone, address, DOB, company) is included in the agent prompt

useBusinessProfileboolean

Whether business Q&A presets are shared with this agent in prompts

useDetachedReceptionistProfileboolean

Whether prompts should use this agent-specific represented receptionist profile

receptionistPreferredNamestring

Prompt-facing represented person, practice, or business name

receptionistCompanyNamestring

Prompt-facing represented company or business name

receptionistCompanyWebsitestring

Prompt-facing represented company website

receptionistCompanyDescriptionstring

Prompt-facing represented company description

receptionistCompanyIndustrystring

Prompt-facing represented company industry

receptionistAddressstring

Prompt-facing represented business street address

receptionistCityNamestring

Prompt-facing represented business city

receptionistStateNamestring

Prompt-facing represented business state

receptionistZipCodestring

Prompt-facing represented business ZIP/postal code

receptionistTimezonestring

Prompt-facing represented business timezone as an IANA timezone name

voicestring

Agent voice

firstMessagestring

First message to be sent to the agent

allowOutboundGreetingInterruptionsboolean

Whether recipients can interrupt the initial greeting on outbound calls

enableVoiceExpressionsboolean

Whether the generated voice prompt includes provider-specific expression guidance

closingPhrasestring

Closing phrase the agent says before ending an inbound call

delayAcceptSecondsnumber

Seconds to wait before the voice agent joins an inbound call.

voiceRecognitionstring

Voice recognition mode: EN for English-only (highest accuracy), MULTI for multilingual support

sttKeytermsstring[]

Names and special words the speech recognizer should expect on calls

temperaturenumber

Temperature for the agent

welcomingVoiceMailMessageForContactsstring

Welcoming voice mail message for contacts

welcomingVoiceMailMessageForOthersstring

Welcoming voice mail message for others

isVoiceMailAgentboolean

Is agent a voice mail agent

voiceSpeednumber

Voice pace from slow to fast. 0.5 is normal/provider default. Not all voice providers support speed control.

incomingCallTypingSoundboolean

Typing sound for the agent

incomingCallBackgroundSoundboolean

Background sound for the agent

outgoingCallBackgroundSoundboolean

Background sound for the agent

outgoingCallTypingSoundboolean

Typing sound for the agent

allowIncomingSmsboolean

Whether the agent allows incoming SMS messages

incomingSmsInstructionsstring

Instructions for the agent on incoming SMS messages

autoRespondToSmsboolean

Whether the agent automatically responds to SMS messages

smsResponseDelaynumber

Delay in seconds before responding to SMS messages

postCallSmsMessagestring

Post-call SMS message to send after incoming calls complete

allowRealtimeSmsboolean

Whether the agent can send SMS messages during calls via the send_sms tool

recordCallsboolean

Whether calls produce audio recordings. Text transcripts remain available when disabled.

requireDataConsentboolean

Whether the agent requires data consent before starting calls

dataConsentTextstring

Custom text/instructions for what consent is being requested for

enablePostCallActionsboolean

Whether to enable post-call outbound actions (scheduling calls after incoming calls)

strictSpamFilterboolean

Strictly reject incoming calls detected as spam before connecting to the agent

skipAiForSyncedContactsboolean

Skip AI: every contact synced from the owner's phone goes to the Skip AI voicemail instead of the receptionist. Contacts saved after calls, on the web, or by import are not included.

valuableCallRulestring nullable

Custom rule for detecting valuable incoming calls after each call.

overrideCallerIdstring

UUID of a verified caller ID to use for outbound calls. Null to clear.

Example response

{
  "tools": [
    {
      "tool": {
        "toolType": "HTTP"
      }
    }
  ],
  "phoneNumbers": [
    {
      "createdAt": "2021-01-01T00:00:00Z",
      "updatedAt": "2021-01-01T00:00:00Z",
      "phoneNumber": "+1234567890",
      "country": "US",
      "agentId": "123",
      "direction": "INCOMING"
    }
  ]
}

Changes

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