Skip to content

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

AuthorizationstringRequired
ApiKey $ENTROVOX_KEY. Keys are issued per organization.

Query parameters

lead_source_idstring or nullOptional
dispositionstring or nullOptional
searchstring or null, max 100Optional
external_idstring or null, 1–128Optional
cursorstring or nullOptional
limitinteger, 1–200Optional

Default 50

screen_statusstring or nullOptional

One offlaggedblocked

Returns

200 OKA page of leads (no calls).

dataarray of objectAlways present
metaobjectAlways present

Errors

  • 400VALIDATION_ERROR

    A 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.

  • 403INSUFFICIENT_SCOPE

    A read key tried to write. Use a key with write scope.

    Retrying will fail the same way. Fix the request, or contact us.

  • 403API_KEY_ENDPOINT_NOT_ALLOWED

    The 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.

  • 403LEAD_SOURCE_NOT_ALLOWED

    The 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.

  • 422VALIDATION_ERROR

    A 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.

  • 422UNSUPPORTED_FILTER

    That 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.