Leads
Retrieve a lead
GET/v1/leads/{lead_id}
The lead's status URL: current disposition, schedule, and call attempts.
API keys get the partner shape with calls[] (transcript, recording and analysis links per attempt). A campaign-bound key gets 404 for a lead outside its campaign.
On this page
Headers
AuthorizationstringRequiredApiKey $ENTROVOX_KEY. Keys are issued per organization.Path parameters
lead_idstringRequiredReturns
200 OKThe status URL: the lead and its call attempts.
attempt_countintegerMay be absentDefault 0
callsarray of object or nullMay be absentcalls_urlstringAlways presentcreated_atstring (date-time)Always presentcurrent_dispositionstringAlways presentdedup_statusstring or nullMay be absentdial_blockerstring or nullMay be absentdisposition_atstring (date-time) or nullMay be absentemailstring or nullMay be absentexternal_idstring or nullMay be absentfirst_namestring or nullMay be absentidstringAlways presentis_dncbooleanMay be absentDefault false
is_testbooleanMay be absentDefault false
jornaya_leadidstring or nullMay be absentlast_attempted_atstring (date-time) or nullMay be absentlast_namestring or nullMay be absentmetadataobjectMay be absentnational_dnc_statusstring or nullMay be absentnext_attempt_atstring (date-time) or nullMay be absentorganization_idstringAlways presentpause_is_queuedbooleanMay be absentDefault false
pausedbooleanMay be absentDefault false
paused_atstring (date-time) or nullMay be absentpaused_reasonstring or nullMay be absentphonestringAlways presentphone_altstring or nullMay be absentpreferred_languagestring or nullMay be absentreplayedboolean or nullMay be absentsequence_statusstring or nullMay be absentsequence_stepintegerMay be absentDefault 0
statestring or nullMay be absentstatus_urlstringAlways presenttimezonestring or nullMay be absenttransfer_phonestring or nullMay be absenttrustedform_cert_urlstring or nullMay be absentupdated_atstring (date-time)Always presentzip_codestring or nullMay be absentErrors
- 403
INSUFFICIENT_SCOPEA read key tried to write. Use a key with write scope.
Retrying will fail the same way. Fix the request, or contact us.
- 403
API_KEY_ENDPOINT_NOT_ALLOWEDThe endpoint is outside the partner surface, or the key's campaign binding is invalid. Ask for a new key.
Retrying will fail the same way. Fix the request, or contact us.
- 404
LEAD_NOT_FOUNDNo lead with that id in your organization.
Retrying will fail the same way. Fix the request, or contact us.
- 422
VALIDATION_ERRORA field is missing or invalid, such as a bad E.164 phone or a missing external_id. param names the field.
Retrying will fail the same way. Fix the request, or contact us.
Any request can also return AUTHENTICATION_REQUIRED, TOKEN_INVALID, API_KEY_EXPIRED, RATE_LIMIT_EXCEEDED or INTERNAL_ERROR.