Sign in

v1

latestOpenAPI 3.0.12026-07-2665150231.1 KB
Outbound

Search Leads

Retrieves the leads associated with a specific outbound

post/v1/Outbound/{outboundId}/Leads

Path parameters

outboundIdstring required

The unique identifier of the outbound.

Request body

skipinteger

Number of entries to skip for pagination.

limitinteger

Limit on the number of entries to return.

sortPropstring nullable

Property name to sort by.

isAscendingboolean

Whether the sort order is ascending.

statusesELeadStatusInputView[] nullable

Optional filters for the status of the leads. Only leads with this status will be included in the results.

searchInputstring nullable

Text to filter by.

Response

List of leads for the outbound.

countinteger

The total number of items matching the search criteria.