Organization API

List Leads

Lists Leads for the authenticated organization with cursor pagination, endpoint-declared filters and sorting, exact custom Field filters using customFields.<savedIdentity>, hydrated customFields, and External References. Supply externalSystem, externalObject, and externalId together to filter by a canonical External Reference. Required scope: leads:read.

/api/v1/leads

List Leads. Use an organization API key with leads:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

leads:read

Parameters

Name	In	Type	Description
limit	query	integer	Maximum number of Leads to return. Values above 100 are capped at 100.
cursor	query	string	Opaque pagination cursor from the previous response meta.nextCursor value.
status	query	NEW \| CONTACTED \| QUALIFIED \| UNQUALIFIED \| CONVERTED	Filter the list to Leads with a specific lifecycle status.
sourceId	query	string	Filter Leads by Lead Source id.
campaignId	query	string	Filter Leads by Campaign id.
salesTypeId	query	string	Filter Leads by one assigned Sales Type id.
ownerId	query	string	Filter Leads by owner Team Member id.
sortBy	query	createdAt \| updatedAt \| status	Lead field used for ordering the list response.
sortDir	query	asc \| desc	Sort direction for the selected sortBy field.
externalSystem	query	string	External Reference system filter. Supply with externalObject and externalId for exact reconciliation lookup.
externalObject	query	string	External Reference object filter. Supply with externalSystem and externalId.
externalId	query	string	External Reference id filter. Supply with externalSystem and externalObject.

Request body

This endpoint does not accept a JSON request body.

Responses

200

Lead list envelope

#/components/schemas/OrgApiListEnvelope

400

Unsupported filter or sort