v1
latestOpenAPI 3.0.12026-07-22120163333.7 KBCommunication V2
Search communications by Agent (cursor paged)
Returns communication timeline entries for the caller (or the caller's team when teamView=true, requiring ACCESS_ALL_TEAM_LEADS permission) within a time range.
- The time window (endTime - startTime) may span up to 90 days in a single query.
- type accepts CALL, TEXT, EMAIL, or ALL to fetch all three together in one request.
- limit controls the page size and must be between 1 and 1000 (default 100).
- Cursor pagination: the response returns a nextCursor token; pass it back as the 'cursor' parameter to fetch the next page. Keep paging while nextCursor is non-null and stop when it is null. Because a full page cannot tell whether more entries exist, the last page may come back with an empty data array and nextCursor=null - treat that as end-of-data, not an error. This is the recommended way to sync large or historical ranges.
get/v2.0/communication/agent
Query parameters
type'CALL' | 'TEXT' | 'EMAIL' | 'ALL'
Communication type to query: CALL, TEXT, EMAIL or ALL.
startTimeinteger required
Start timestamp (epoch milliseconds), inclusive.
endTimeinteger required
End timestamp (epoch milliseconds), inclusive. The interval (endTime - startTime) cannot exceed 90 days.
limitinteger
Number of entries per page.
cursorstring
Opaque pagination token returned as nextCursor by the previous page. Omit for the first page.
teamViewboolean
Search the team leads' communications. Requires ACCESS_ALL_TEAM_LEADS permission. Default false.
Headers
Authorizationstring required
Bearer [access_token]
Response
Cursor-paged communication entries.
Example response
{
"data": [
{
"direction": "Outbound",
"callOutcome": "Talked",
"status": "Delivered",
"communicationType": "AUTO",
"eventType": "Call"
}
],
"hasMore": true,
"limit": 100,
"totalCount": 1234
}