listTeammates

Lists the teammates in the company.

function listTeammates(paginationToken?: string, cancelToken?: CancelToken): Promise<PaginatedResults<Teammate>>

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 teammates.

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