Leads
List leads
GET/v1/leads
List leads, or look one up by your external_id.
API keys get the partner lead shape with status_url / calls_url on every row; a campaign-bound key sees only its campaign. screen_status is not supported here: the partner list refuses it rather than ignore it.
On this page
Headers
AuthorizationstringRequiredApiKey $ENTROVOX_KEY. Keys are issued per organization.Query parameters
lead_source_idstring or nullOptionaldispositionstring or nullOptionalsearchstring or null, max 100Optionalexternal_idstring or null, 1–128Optionalcursorstring or nullOptionallimitinteger, 1–200OptionalDefault 50
screen_statusstring or nullOptionalOne offlaggedblocked
Returns
200 OKA page of leads (no calls).
dataarray of objectAlways presentmetaobjectAlways presentErrors
- 400
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.
- 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.
- 403
LEAD_SOURCE_NOT_ALLOWEDThe body names a campaign other than the one this key is bound to.
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.
- 422
UNSUPPORTED_FILTERThat filter is not available to API keys.
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.