listInboxes

Lists the inboxes accessible by the current teammate.

function listInboxes(paginationToken?: string, cancelToken?: CancelToken): Promise<PaginatedResults<Inbox>>

Parameters

ParameterTypeDescription
paginationTokenPaginationTokenToken of the requested page. If omitted, will return the first page of results.
cancelTokenCancel tokenToken to cancel the request.

Return value

The function returns a promise that resolves with a paginated list of inboxes.

PropertyTypeDescription
nextPageTokenPaginationToken (optional)Token to access the next page of results, if any.
resultsArray of InboxList of inboxes.