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

Query Parameters

tagIds
string[]
tagMatchAll
boolean
untagged
boolean
archiveFilter
string

Body

A token to cancel the operation.

Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.

pageSize
string<int32>

Maximum items to return in one page

Pattern: ^-?(?:0|[1-9]\d*)$
continuationToken
string | null

Opaque Cosmos DB continuation token. ‑ on the first request. ‑ Client must echo back the NextToken it received from the previous page.

orderBy
object[] | null

List of sort instructions, in priority order.

includeCount
boolean | null

Whether to include the total count in the response (for pagination).

search
string | null

The search term to filter results (applied to ).

searchFields
string[] | null

The list of fields to apply the Search term to (must be string properties).

filters
object[] | null

Key-value exact match filters (e.g., Status = Active).

rangeFilters
object[] | null

Advanced range-based filters (e.g., Price > 50 and Price <= 200).

Response

Leads were successfully retrieved.

A generic container for paginated results returned to the client.

items
object[]

The subset of items returned for the current page.

pageSize
string<int32>

The number of items returned per page in the response. This may reflect the client's requested page size, or a server-defined default or limit.

Pattern: ^-?(?:0|[1-9]\d*)$
totalCount
string<int32> | null

The total number of items that match the query across all pages. May be null if the count is not computed or not applicable (e.g., in continuation-based pagination).

Pattern: ^-?(?:0|[1-9]\d*)$
continuationToken
string | null

Opaque storage continuation token. ‑ null → the current page was the last page.