1. calls
SkipCalls Public API
  • users
    • Get current user profile
      GET
    • Sync contacts from mobile device
      POST
    • Delete all contacts
      DELETE
    • Get all contacts
      GET
    • Update contact
      PATCH
    • Get a single contact with stats
      GET
    • Find duplicate contacts
      GET
    • Merge two duplicate contacts
      POST
    • Search contacts
      POST
    • Import contacts from CSV or JSON file
      POST
    • Get tag statistics for autocomplete
      GET
    • Advanced search in contacts by name, company, and tags
      POST
    • List notes for a customer (newest first)
      GET
    • Add a note to a customer
      POST
    • Get unified timeline for a customer
      GET
    • Update a customer note
      PATCH
    • Delete a customer note
      DELETE
    • Update custom fields on a customer
      PATCH
  • Calendars
    • List booked appointments
    • Get upcoming appointments for widget
    • Get appointment statistics
    • Get a single appointment
    • Hide/delete an appointment from the list
  • calls
    • Transcribe audio (for chat)
      POST
    • Schedule a new call
      POST
    • Cancel a scheduled call by ID
      DELETE
    • Get call details
      GET
    • Copy a call
      POST
    • Get call history
      GET
    • Search calls
      GET
    • Search outgoing calls only
      GET
    • Rate a call
      POST
    • Drop a call immediately by ID
      POST
    • Add call to favorites
      POST
    • Remove call from favorites
      DELETE
    • Update call notes
      PATCH
  • incoming-calls
    • Get incoming call history
    • Search incoming calls only
    • Get incoming call details
    • Delete an incoming call
    • Block the caller phone number from this incoming call
    • Unblock the caller phone number from this incoming call
    • Drop an incoming call immediately by ID
    • Add incoming call to favorites
    • Remove incoming call from favorites
  • agents
    • Create a new agent
    • Get all not deleted agents for the current user
    • Get all public agents
    • Get a specific agent by ID
    • Update an agent
    • Delete an agent
    • Toggle an agent active status
    • Reset an agent to dashboard defaults
    • Get agent change history
    • Create agent evaluation
    • Get agent evaluations
    • Update agent evaluation
    • Delete agent evaluation
    • Create agent data collection
    • Get agent data collections
    • Update agent data collection
    • Delete agent data collection
    • Connect calendar to agent
    • Get agent connected calendars
    • Duplicate an agent-calendar link (virtual calendar)
    • Update calendar settings
    • Disconnect calendar from agent
    • Create or update widget embed configuration
    • Get widget embed configuration
    • Disable widget embed
    • Regenerate embed key
    • Get all transfer numbers for an agent
    • Add a new transfer number to an agent
    • Update a transfer number
    • Delete a transfer number
    • List all tasks available to user (global + custom)
    • Create a custom task definition
    • Delete a custom task definition
    • List call scenarios for an agent
    • Create a call scenario for an agent
    • Reorder call scenarios for an agent
    • Update a call scenario
    • Delete a call scenario
    • List enabled tasks for an agent
    • Enable a task on an agent
    • Disable a task on an agent
  • email-receptionist
    • Get email receptionist settings for an agent
    • Create or update email receptionist settings for an agent
  • contact-actions
    • Schedule an outbound call to a contact
    • Send an SMS to a contact
  • Schemas
    • UserProfileSubscriptionDto
    • UserProfileResponseDto
    • UserTrialResponseDto
    • UserStatsResponseDto
    • UserPhoneResponseDto
    • GetUserProfileResponseDto
    • ContactDto
    • SyncContactsDto
    • BasicResponseDto
    • DeleteContactsDto
    • UpdateContactDto
    • ContactStatsDto
    • ContactLatestNoteDto
    • ContactItemResponseDto
    • MergeContactDataDto
    • MergeContactsDto
    • PaginationDto
    • ContactAggregationsDto
    • ContactSearchResponseDto
    • ImportContactsDto
    • ImportContactsResponseDto
    • TagStatDto
    • TagStatsResponseDto
    • AdvancedSearchDto
    • AddCustomerNoteDto
    • UpdateCustomerNoteDto
    • AppointmentAgentDto
    • AppointmentCalendarDto
    • AppointmentResponseDto
    • AppointmentsListResponseDto
    • AppointmentStatsDto
    • NumberAgentDto
    • NumberItemDto
    • TranscribeDto
    • TranscribeResponseDto
    • ScheduleCallDto
    • TransactionDto
    • RoleplayTranscriptMetadataDto
    • RoleplayTranscriptDto
    • SchemaFieldValidationsDto
    • CalculatedFieldDto
    • SchemaFieldDto
    • ToolDto
    • AgentToolDto
    • DataCollectionResultDto
    • DataCollectionResponseDto
    • EvaluationResultDto
    • EvaluationResponseDto
    • FlowStructureDto
    • AgentEmailAddressDto
    • AgentDto
    • VoiceMailMessagesDto
    • CallAnalysisDto
    • CallFollowUpDto
    • TaskDto
    • TaskResultDto
    • CallDto
    • BaseCallResponseDto
    • BaseUnsuccessfulCallResponseDto
    • CallSimpleResponseDto
    • CopyCallDto
    • CallHistoryResponseDto
    • SearchCallResultDto
    • SearchCallsResponseDto
    • RateCallDto
    • UpdateCallNotesDto
    • DataCollectionDto
    • EvaluationDto
    • CallBookingDto
    • IncomingCallDto
    • IncomingCallHistoryResponseDto
    • BlockCallerResponseDto
    • FlowStructure
    • CreateAgentDto
    • AgentValidationDto
    • UpdateAgentDto
    • AgentAuditLogEntryDto
    • AgentAuditHistoryResponseDto
    • CreateAgentEvaluationDto
    • UpdateAgentEvaluationDto
    • CreateAgentDataCollectionDto
    • UpdateAgentDataCollectionDto
    • CreateAgentCalendarDto
    • DuplicateAgentCalendarDto
    • UpdateAgentCalendarDto
    • CreateWidgetConfigDto
    • WidgetConfigResponseDto
    • CreateTransferNumberDto
    • TransferNumberResponseDto
    • UpdateTransferNumberDto
    • TaskDefinitionDto
    • CreateCustomTaskDto
    • AgentScenarioResponseDto
    • CreateAgentScenarioDto
    • ReorderAgentScenariosDto
    • UpdateAgentScenarioDto
    • AgentTaskLinkDto
    • EnableTaskDto
    • EmailReceptionistSettingsResponseDto
    • UpdateEmailReceptionistSettingsDto
    • ScheduleCallFromContactDto
    • SendSmsFromContactDto
  1. calls

Get call details

GET
/calls/{id}
Returns the full call record with all relations loaded: transactions (billing), agent, voicemails, dataCollections, evaluations, tasks, analysis, followUps, plus computed fields isFavorite, shareHash, and a plain-text transcription rendered from roleplayTranscript. For in-progress calls some fields (finalSummary, minutesUsed) may be partial.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Path Params

Responses

🟢200
application/json
Bodyapplication/json

🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/calls/' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "id": "string",
    "userId": "string",
    "phoneNumber": "string",
    "source": "LEGACY_UNKNOWN",
    "callFrom": "string",
    "goal": "string",
    "goalStatus": "UNKNOWN",
    "scheduledAt": "2019-08-24T14:15:22.123Z",
    "title": "string",
    "status": "QUEUED",
    "additionalContext": "string",
    "minutesUsed": 0,
    "transactions": [
        {
            "minutes": 0,
            "type": "string",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "description": "string"
        }
    ],
    "voice": "string",
    "retryAfterMinutes": 0,
    "maxDurationMinutes": 0,
    "doWeNeedToRetry": true,
    "recordingUrl": "string",
    "userRating": true,
    "reviewedAt": "2019-08-24T14:15:22.123Z",
    "finalSummary": "string",
    "shortFinalSummary": "string",
    "placeWhereToCall": "string",
    "roleplayTranscript": [
        {
            "from": "ai",
            "text": "string",
            "metadata": {
                "tone": "string",
                "emotion": "string",
                "language": "string",
                "sentiment": "string"
            },
            "timestamp": 0
        }
    ],
    "agent": {
        "id": "string",
        "name": "string",
        "description": "string",
        "avatar": "string",
        "isPublic": true,
        "isActive": true,
        "instructions": "string",
        "incomingCallInstructions": "string",
        "maxIncomingCallDurationMinutes": 0,
        "maxOutgoingCallDurationMinutes": 0,
        "gatheringInformationOnIncomingCall": true,
        "createdAt": "2019-08-24T14:15:22.123Z",
        "updatedAt": "2019-08-24T14:15:22.123Z",
        "deletedAt": "2019-08-24T14:15:22.123Z",
        "userId": "string",
        "tools": [
            {
                "agentId": "string",
                "toolId": "string",
                "createdAt": "2019-08-24T14:15:22.123Z",
                "tool": {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "instruction": "string",
                    "toolType": "HTTP",
                    "url": "string",
                    "method": "GET",
                    "headers": {
                        "Authorization": "Bearer token123",
                        "Content-Type": "application/json"
                    },
                    "mcpServerUrl": "string",
                    "mcpServerHeaders": {},
                    "mcpServerName": "string",
                    "mcpToolName": "string",
                    "codeLanguage": "PYTHON",
                    "codeSource": "string",
                    "codeTestCases": {},
                    "inputSchema": {
                        "name": "string",
                        "type": "string",
                        "description": "string",
                        "children": [
                            {
                                "name": "query",
                                "type": "string",
                                "description": "Search query",
                                "validations": {
                                    "required": true,
                                    "min": 1,
                                    "max": 100
                                },
                                "label": "Search Query"
                            },
                            {
                                "name": "category",
                                "type": "enum",
                                "description": "Category filter",
                                "enumValues": [
                                    "news",
                                    "weather",
                                    "sports"
                                ],
                                "validations": {
                                    "required": false
                                }
                            }
                        ],
                        "enumValues": [
                            "string"
                        ],
                        "validations": {
                            "required": true,
                            "min": 0,
                            "max": 0,
                            "regex": "string",
                            "custom": "string",
                            "default": "string"
                        },
                        "label": "string",
                        "calculatedField": {
                            "dependencies": [
                                "string"
                            ],
                            "formula": "string"
                        }
                    },
                    "isActive": true,
                    "createdAt": "2019-08-24T14:15:22.123Z",
                    "updatedAt": "2019-08-24T14:15:22.123Z"
                }
            }
        ],
        "accessToKnowledge": true,
        "knowledgeAccessMode": "NONE",
        "knowledgeAccessTags": [
            "string"
        ],
        "allowFollowUps": true,
        "followUpInstructions": "string",
        "includePrivateData": true,
        "useBusinessProfile": true,
        "useDetachedReceptionistProfile": true,
        "receptionistPreferredName": "string",
        "receptionistCompanyName": "string",
        "receptionistCompanyWebsite": "string",
        "receptionistCompanyDescription": "string",
        "receptionistCompanyIndustry": "string",
        "receptionistAddress": "string",
        "receptionistCityName": "string",
        "receptionistStateName": "string",
        "receptionistZipCode": "string",
        "receptionistTimezone": "string",
        "voice": "string",
        "modelName": {},
        "allowCallTransfer": true,
        "callTransferNumber": "string",
        "transferHours": {
            "MONDAY": [
                900,
                1730
            ],
            "TUESDAY": [
                900,
                1730
            ],
            "WEDNESDAY": [
                900,
                1730
            ],
            "THURSDAY": [
                900,
                1730
            ],
            "FRIDAY": [
                900,
                1730
            ]
        },
        "firstMessage": "string",
        "allowOutboundGreetingInterruptions": false,
        "enableVoiceExpressions": true,
        "closingPhrase": "string",
        "delayAcceptSeconds": 0,
        "voiceRecognition": "EN",
        "temperature": 0,
        "dataCollections": [
            {
                "dataIdentifier": "string",
                "description": "string",
                "dataType": "STRING",
                "id": "string",
                "createdAt": "2019-08-24T14:15:22.123Z",
                "updatedAt": "2019-08-24T14:15:22.123Z",
                "agentId": "string",
                "results": [
                    {
                        "id": "string",
                        "dataCollectionId": "string",
                        "callId": "string",
                        "createdAt": "2019-08-24T14:15:22.123Z",
                        "updatedAt": "2019-08-24T14:15:22.123Z",
                        "dataValue": {
                            "property1": "string",
                            "property2": "string"
                        }
                    }
                ]
            }
        ],
        "evaluations": [
            {
                "name": "string",
                "prompt": "string",
                "id": "string",
                "createdAt": "2019-08-24T14:15:22.123Z",
                "updatedAt": "2019-08-24T14:15:22.123Z",
                "agentId": "string",
                "results": [
                    {
                        "id": "string",
                        "callId": "string",
                        "evaluationId": "string",
                        "createdAt": "2019-08-24T14:15:22.123Z",
                        "updatedAt": "2019-08-24T14:15:22.123Z",
                        "type": "SUCCESS",
                        "rationale": "string"
                    }
                ]
            }
        ],
        "welcomingVoiceMailMessageForContacts": "string",
        "welcomingVoiceMailMessageForOthers": "string",
        "isVoiceMailAgent": false,
        "outgoingCallFlow": {
            "nodes": [
                {}
            ],
            "edges": [
                {}
            ]
        },
        "incomingCallFlow": {
            "nodes": [
                {}
            ],
            "edges": [
                {}
            ]
        },
        "voiceSpeed": 0.5,
        "incomingCallTypingSound": true,
        "incomingCallBackgroundSound": true,
        "outgoingCallBackgroundSound": true,
        "outgoingCallTypingSound": true,
        "allowIncomingSms": false,
        "incomingSmsInstructions": "",
        "autoRespondToSms": true,
        "smsResponseDelay": 1,
        "useSmsIncomingCallFlow": false,
        "postCallSmsMessage": "string",
        "allowRealtimeSms": false,
        "phoneNumbers": [
            {
                "id": "string",
                "createdAt": "2021-01-01T00:00:00Z",
                "updatedAt": "2021-01-01T00:00:00Z",
                "phoneNumber": "+1234567890",
                "country": "US",
                "isActive": true,
                "agent": {
                    "id": "string",
                    "name": "string"
                },
                "agentId": "123",
                "direction": "INCOMING",
                "isSharedOutbound": false,
                "provider": "TWILIO",
                "source": "RENTED",
                "readyToRelease": false,
                "markedReadyToReleaseAt": "2019-08-24T14:15:22.123Z",
                "markToDeleteAt": "2019-08-24T14:15:22.123Z",
                "lastBilledAt": "2019-08-24T14:15:22.123Z",
                "monthlyCost": "1.15",
                "isTestNumber": false
            }
        ],
        "emailAddress": {
            "address": "string",
            "status": "ACTIVE"
        },
        "requireDataConsent": false,
        "dataConsentText": "string",
        "enablePostCallActions": false,
        "postCallActionInstructions": "string",
        "behaviorPreset": "default",
        "strictSpamFilter": false,
        "valuableCallRule": "string",
        "overrideCallerId": "string"
    },
    "voicemails": [
        {
            "transcription": "string",
            "audioUrl": "string",
            "duration": 0,
            "createdAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "callTransferNumber": "string",
    "isCallTransferred": false,
    "allowCallTransfer": false,
    "dataCollections": [
        {
            "id": "string",
            "dataCollectionId": "string",
            "callId": "string",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "dataValue": {
                "property1": "string",
                "property2": "string"
            }
        }
    ],
    "evaluations": [
        {
            "id": "string",
            "callId": "string",
            "evaluationId": "string",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "type": "SUCCESS",
            "rationale": "string"
        }
    ],
    "analysis": {
        "sentiment": "positive",
        "sentimentScore": 0,
        "detectedLanguage": "string",
        "detectedLanguageConfidence": 0
    },
    "followUps": [
        {
            "id": "string",
            "type": "SMS",
            "content": "string",
            "recipientEmail": "string",
            "recipientPhone": "string",
            "status": "PENDING",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "triggeredByCallId": "string"
        }
    ],
    "tasks": [
        {
            "id": "string",
            "title": "string",
            "description": "string",
            "status": "TODO",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "dueDate": "2019-08-24T14:15:22.123Z",
            "priority": "HIGH",
            "leadNotes": "string",
            "leadStatus": "string",
            "tags": [
                "string"
            ],
            "isAiGenerated": true,
            "completedAt": "2019-08-24T14:15:22.123Z",
            "completedBy": "string"
        }
    ],
    "taskResults": [
        {
            "id": "string",
            "slug": "string",
            "title": "string",
            "groupName": "string",
            "status": "completed",
            "reason": "string",
            "createdAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "voiceSpeed": 0,
    "callTypingSound": true,
    "callBackgroundSound": true,
    "recommendedNextAction": "string",
    "testCall": false,
    "isFavorite": false,
    "callInterceptedByUser": false,
    "shareHash": "string",
    "matchedFields": [
        "phone",
        "summary",
        "title",
        "goal"
    ],
    "notes": "string",
    "contactId": "123e4567-e89b-12d3-a456-426614174000"
}
Modified at 2026-07-23 18:02:16
Previous
Cancel a scheduled call by ID
Next
Copy a call
Built with