Leads

List leads

Changed on

Returns a cursor-paginated list of the caller-owned leads, newest first. Filter by stage, type, contact email, and creation date.

get/leads

Request

  • Base URL: https://api.ekho.com
  • URL: https://api.ekho.com/leads
  • Auth: HTTP bearer

Query parameters

limitinteger

Page size, 1 to 100.

Example:20
starting_afterstring

Return the page after this resource id (newest first).

stage'new' | 'to_reach_out' | 'engaged' | 'needs_attention' | 'booked' | 'on_hold' | 'closed_won' | 'closed_lost'

Filter to a single lead stage.

type'partial_order' | 'partial_preorder' | 'rejected_financing' | 'buy_in_person' | 'inquiry' | 'conversation' | 'pre_qual' | 'external_crm' | 'adf'

Filter to a single lead type.

emailstring

Exact-match contact email; backs the find-lead search.

created[gte]integer

Only leads created at or after this epoch ms.

Example:1767225600000
created[lte]integer

Only leads created at or before this epoch ms.

Example:1767225600000

Response

A page of leads.

has_moreboolean required

True when another page follows the returned one.

next_cursorstring nullable required

Pass as starting_after to fetch the next page; null when has_more is false.

Example response

{
  "data": [
    {
      "id": "Kj7Xp2mQvR4tLw9dZa3B"
    }
  ]
}

Changes

  • 78c545d96a34Revision changes
    • warning

      added the new adf enum value to the // response property for the response status

    • warning

      added the new external_id_in_use enum value to the response property for the response status

    • warning

      added the new external_id_in_use enum value to the response property for the response status

    • warning

      added the new external_id_in_use enum value to the response property for the response status

    • warning

      added the new external_id_in_use enum value to the response property for the response status

    • warning

      added the new external_id_in_use enum value to the response property for the response status

    • warning

      added the new requires_ekho_review enum value to the response property for the response status

    • warning

      added the new requires_ekho_review enum value to the response property for the response status

    • warning

      added the new requires_ekho_review enum value to the response property for the response status

    • warning

      added the new requires_ekho_review enum value to the response property for the response status

    • warning

      added the new requires_ekho_review enum value to the response property for the response status

    • warning

      added the new resource_not_writable enum value to the response property for the response status

    • warning

      added the new resource_not_writable enum value to the response property for the response status

    • warning

      added the new resource_not_writable enum value to the response property for the response status

    • warning

      added the new resource_not_writable enum value to the response property for the response status

    • warning

      added the new resource_not_writable enum value to the response property for the response status

    • info

      added the new enum value adf to the query request parameter type

  • 9ea18a1c9c8aRevision changes
    • warning

      added the new https://docs.ekhodealer.com/api-reference/errors/insufficient-access enum value to the response property for the response status

    • warning

      added the new https://docs.ekhodealer.com/api-reference/errors/insufficient-access enum value to the response property for the response status

    • warning

      added the new https://docs.ekhodealer.com/api-reference/errors/insufficient-access enum value to the response property for the response status

    • warning

      added the new https://docs.ekhodealer.com/api-reference/errors/insufficient-access enum value to the response property for the response status

    • warning

      added the new https://docs.ekhodealer.com/api-reference/errors/insufficient-access enum value to the response property for the response status

    • warning

      added the new insufficient_access enum value to the response property for the response status

    • warning

      added the new insufficient_access enum value to the response property for the response status

    • warning

      added the new insufficient_access enum value to the response property for the response status

    • warning

      added the new insufficient_access enum value to the response property for the response status

    • warning

      added the new insufficient_access enum value to the response property for the response status