Outbound

Search Leads

Retrieves the leads associated with a specific outbound

post/v1/Outbound/{outboundId}/Leads

Request

Base URL
https://api.nlpearl.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nlpearl/apis/nlpearl-client-api/docs/v1/Outbound/:outboundId/Leads/post.ts
A function with typed inputs. Its response is checked against the schema.

outboundIdstring required

The unique identifier of the outbound.

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.

List of leads for the outbound.

countinteger

The total number of items matching the search criteria.

No recorded changes to this operation across all 1 revision of this API.