Skip to navigation

List reps

With whether each one’s softphone is online now.

Needs the calls:read scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

OK
idstring
A UUID.
externalIdstring
Your id for the rep.
addedByobject or null

What added the rep: a connected app (app), one of your API keys (api_key) or a person (person), and its name then. Null for reps from before 17 Nov 2026.

namestring
mobileNumberstring or null
voicemailVoicestring or null
onlineboolean
Their softphone is in its presence room now.
lastSeenAtdatetime or null
createdAtdatetime

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error