Skip to main content
GET
Search communications by Agent (cursor paged)

Headers

Authorization
string
required

Bearer [access_token]

Query Parameters

type
enum<string>

Communication type to query: CALL, TEXT, EMAIL or ALL.

Available options:
CALL,
TEXT,
EMAIL,
ALL
startTime
integer<int64>
required

Start timestamp (epoch milliseconds), inclusive.

endTime
integer<int64>
required

End timestamp (epoch milliseconds), inclusive. The interval (endTime - startTime) cannot exceed 90 days.

limit
integer<int32>
default:100

Number of entries per page.

Required range: 1 <= x <= 1000
cursor
string

Opaque pagination token returned as nextCursor by the previous page. Omit for the first page.

teamView
boolean
default:false

Search the team leads' communications. Requires ACCESS_ALL_TEAM_LEADS permission. Default false.

Response

Cursor-paged communication entries.

data
object[]

Communication entries for this page.

nextCursor
string

Opaque cursor for the next page. Pass it back as the 'cursor' parameter. Null when there are no more pages. A non-null value does not guarantee further entries: the next request may return an empty data array with nextCursor=null, which marks the end.

hasMore
boolean

Whether more pages are available.

Example:

true

limit
integer<int32>

Page size used for this query.

Example:

100

totalCount
integer<int64>

Total number of matching entries for the whole query.

Example:

1234