v1

latestOpenAPI 3.1.02026-08-04253331435.1 KB
CRM Leads

Search Leads

Search for leads using various criteria.

Query parameters:

  • query: Text search across name and company
  • lastname: Filter by last name
  • company: Filter by company name
  • email: Filter by email
  • status: Filter by lead status
  • industry: Filter by industry

Note: This endpoint is only supported for Salesforce integrations.

get/api/v3/crm/{integration_id}/leads/search

Path parameters

integration_idstring uuid required

The CRM integration ID

The CRM integration ID

Query parameters

querystring nullable

Text search

Text search

lastnamestring nullable

Last name

Last name

companystring nullable

Company name

Company name

emailstring nullable

Email address

Email address

statusstring nullable

Lead status

Lead status

industrystring nullable

Industry

Industry

limitinteger

Number of results

Number of results

Response

Successful Response

has_moreboolean required
next_cursorstring nullable