Pearl

Get Calls

Retrieves the calls within a specific date range of a pearl

post/v2/Pearl/{pearlId}/Calls

Request

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

pearlIdstring required

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.

fromDatestring date-time required

The start date for filtering the search results.

toDatestring date-time required

The end date for filtering the search results.

tagsstring[] nullable

List of tags to filter by.

statusesEConversationStatusView[] nullable

List of Status to filter by.

searchInputstring nullable

Text to filter by.

Calls within the specified date range for inbound.

countinteger

The total number of items matching the search criteria.

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