Skip to main content
POST
List organization lead records for current user

Authorizations

Authorization
string
header
required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Query Parameters

tagIds
string[]

Optional tag identifiers used to filter the lead list.

tagMatchAll
boolean

Whether a lead must contain every supplied tag instead of any supplied tag.

untagged
boolean

Whether to include only leads that have no tags.

archiveFilter
string

Optional filter selecting active, archived, or all leads.

Body

Pagination, filtering, and sorting options for lead records.

Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.

pageSize
integer<int32>

Maximum number of items requested for one page; the server may enforce a lower maximum or apply a default.

continuationToken
null | string

Opaque cursor returned by the previous paged response; omit it when requesting the first page and do not parse or modify it.

orderBy
null | object[]

Sort instructions applied in priority order, with the first entry acting as the primary sort.

includeCount
null | boolean

Whether the response should include the total number of matching records; counting may increase query cost or latency.

search
null | string

Free-text search term applied to the configured SearchFields.

searchFields
null | string[]

Serializable string field names searched for Search; supported names are determined by the queried resource.

filters
null | object[]

Exact-match conditions that require each named field to equal its supplied value.

rangeFilters
null | object[]

Range conditions that constrain comparable fields with inclusive or exclusive lower and upper bounds.

Response

Leads were successfully retrieved.

Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata.

items
object[]

Items included in the current page, in the order determined by the query.

pageSize
integer<int32>

Effective page-size limit used for this response, which may differ from the requested size because of server defaults or limits.

totalCount
null | integer<int32>

Total number of records matching the query across all pages, or null when counting was not requested or computed.

continuationToken
null | string

Opaque cursor for requesting the next page, or null when no additional page is available; clients must not parse or modify it.