API reference

Call Jobs

7 endpoints. Add your API key in the authentication panel to send test requests from this page.

List call jobs

GET/api/external/v1/call-jobs

Retrieves a paginated list of all call jobs owned by the user associated with the API key. Allows filtering by application and ignoring system jobs.

Parameters

applicationIdstring (uuid)query
Filter by specific application UUID
ignoreSystemJobsbooleanquery
Exclude system call jobs (e.g. Generated Calls)
pageinteger (int32)query
Page number (0-indexed)
sizeinteger (int32)query
Items per page (max 100)

Responses

200Paginated list of call jobs
401Missing or invalid API key
403Key is valid but lacks access to this resource
404Requested resource not found

Get call job

GET/api/external/v1/call-jobs/{jobId}

Retrieves the details of a specific call job by its unique UUID. Includes configuration, status, and progress metrics.

Parameters

jobIdstring (uuid)pathRequired
The unique UUID of the call job

Responses

200Call job details
401Missing or invalid API key
403Key is valid but lacks access to this resource
404Requested resource not found

Update call job

PATCH/api/external/v1/call-jobs/{jobId}

Updates editable fields of an existing call job. Allows modifying execution settings, scheduling, and retry configurations.

Patchable fields: executionMode, status, flowId, flowApiId, manualTriggerSecret, allowedCallWindowStart (HH:mm:ss), allowedCallWindowEnd (HH:mm:ss), allowedPhoneNumbers, scheduledAt (ISO 8601), maxConcurrentCalls, enableRetries, maxRetries, retryDelay, retryOnBusy, retryOnNoAnswer, retryOnVoicemail.

flowId accepts either the internal UUID or the flow API ID. flowApiId is an explicit alias for API-ID based updates. Provide at most one of them.

Parameters

jobIdstring (uuid)pathRequired
The unique UUID of the call job

Request body application/json

object

Responses

200Updated call job
401Missing or invalid API key
403Key is valid but lacks access to this resource
404Requested resource not found

Delete call job

DELETE/api/external/v1/call-jobs/{jobId}

Permanently deletes a call job and all its associated call rows. This action cannot be undone.

Parameters

jobIdstring (uuid)pathRequired
The unique UUID of the call job

Responses

204Successfully deleted
401Missing or invalid API key
403Key is valid but lacks access to this resource
404Requested resource not found

Get rows for call job

GET/api/external/v1/call-jobs/{jobId}/rows

Returns all call rows associated with a specific call job. Useful for checking the status or individual results of a bulk upload.

Parameters

jobIdstring (uuid)pathRequired
The unique UUID of the call job
flattenOutputsbooleanquery
Merge each structured output's fields flat onto the root, matching the API's original (pre-nesting) shape. Set to false to get the real object structure, grouped by output name.

Responses

200List of call rows for this job
401Missing or invalid API key
403Key is valid but lacks access to this resource
404Requested resource not found

Create call job (CSV)

POST/api/external/v1/call-jobs/csv

Creates a new call job by providing CSV content. This is suitable for bulk uploads where data is already in a tabular format. The first row of the CSV must contain the headers.

To assign one default flow for the whole job, provide either flowId (internal UUID or flow API ID) or flowApiId (preferred for external integrations). Do not send both.

For multi-flow jobs, omit the default flow fields and add a flow column containing each row's flow API ID.

Request body application/json

originalFileNamestring
Internal name for the job (e.g., filename)
csvContentstring
The full CSV content string
flowIdstring
Optional default flow reference. Accepts the internal UUID or the flow API ID exposed in API responses.
flowApiIdstring
Optional default flow API ID. Preferred for external integrations. Provide either flowId or flowApiId, not both.
executionModestring
Concurrency mode (IN_PARALLEL, SERIAL)
initialStatusstring
Initial status of the job
allowedCallWindowStartstring
Local time to start making calls (HH:mm:ss)
allowedCallWindowEndstring
Local time to stop making calls (HH:mm:ss)
allowedPhoneNumbersarray of string
Optional from-number allowlist. Null/empty means all available.
scheduledAtstring (date-time)
Scheduled date/time for the job (ISO 8601)
maxConcurrentCallsinteger (int32)
Maximum concurrent calls (default 1)
enableRetriesboolean
Enable automatic retries for failed calls
maxRetriesinteger (int32)
Maximum number of retries per row
retryDelayinteger (int32)
Delay between retries in seconds
retryOnBusyboolean
Retry if the destination is busy
retryOnNoAnswerboolean
Retry if there is no answer
retryOnVoicemailboolean
Retry if the call reaches voicemail
applicationIdstring (uuid)
Optional application UUID. If omitted, the user's default application is used.

Responses

201Call job created successfully
400Invalid CSV content or missing required fields
401Missing or invalid API key
403Key is valid but lacks access to this resource
404Requested resource not found

Create call job (JSON)

POST/api/external/v1/call-jobs/json

Creates a call job from JSON content. This is preferred over CSV for many rows or complex data.

To assign one default flow for the whole job, provide either flowId (internal UUID or flow API ID) or flowApiId (preferred for external integrations). Do not send both.

For multi-flow jobs, omit the default flow fields and set flowApiId on each row instead.

Request body application/json

flowIdstring
Optional default flow reference. Accepts the internal UUID or the flow API ID exposed in API responses.
flowApiIdstring
Optional default flow API ID. Preferred for external integrations. Provide either flowId or flowApiId, not both.
executionModestring
How to execute the jobs
initialStatusstring
The status the job starts in
allowedCallWindowStartstring
Start of allowed call window (HH:mm:ss)
allowedCallWindowEndstring
End of allowed call window (HH:mm:ss)
allowedPhoneNumbersarray of string
Optional from-number allowlist. Null/empty means all available.
scheduledAtstring (date-time)
Optional scheduled start time (ISO)
maxConcurrentCallsinteger (int32)
Max concurrent calls for this job
enableRetriesboolean
Whether to retry failed calls
maxRetriesinteger (int32)
Max number of retries
retryDelayinteger (int32)
Delay between retries in seconds
retryOnBusyboolean
Retry if the destination is busy
retryOnNoAnswerboolean
Retry if there is no answer
retryOnVoicemailboolean
Retry if the call reaches voicemail
applicationIdstring (uuid)
Optional application UUID. If omitted, the user's default application is used.
rowsarray of ExternalCallRowData
The actual call rows. At least one row is required.

Responses

201Call job created successfully
400Invalid payload
401Missing or invalid API key
403Key is valid but lacks access to this resource
404Requested resource not found