Sign in
public

List leads

List active leads assigned to a voice agent using cursor pagination.

get/api/v1/public/agents/{agent_id}/leads

Path parameters

agent_idstring required

Query parameters

cursorstring nullable

Opaque cursor returned by the previous page.

Opaque cursor returned by the previous page.

limitinteger nullable

Maximum number of records to return. Omit with cursor to use 50. Omit both cursor and limit for the legacy unpaginated v1 response.

Maximum number of records to return. Omit with cursor to use 50. Omit both cursor and limit for the legacy unpaginated v1 response.

Response

Successful Response

LeadResponse[] required

Changes

Changed in 3 of the 16 revisions of this API.5102

  • f7903dc1bdbb2See the full diff
    • ○

      added the new optional query request parameter cursor

      new-optional-request-parameter

    • ○

      added the new optional query request parameter limit

      new-optional-request-parameter

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7c9aff2501f3410See the full diff
    • ▲

      removed the required property items/createdAt from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property items/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property items/name from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property items/updatedAt from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property items/agentId from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/campaignId from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/customFields from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/description from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/email from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/externalRef from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/externalSource from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/phone from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/source from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/status from the response with the 200 status

      response-optional-property-removed

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e7248cb2f50b1See the full diff
    • ▲

      the response's body type/format changed from / to array/ for status 200

      response-body-type-changed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog