Skip to main content
GET
Get a user's status

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Path Parameters

userId
string
required

The user's id.

Example:

"4207"

Response

The user's status.

userId
string
required

The user's id.

Example:

"4207"

status
string
required

What the user is doing now: online, idle, offline, on_call or after_call_work. The same values as status on the user.status_changed webhook. New values may be added later, so handle unknown values.

Example:

"idle"

statusType
object
required

The status type the user picked. It is kept during calls and while signed out.

customText
string | null
required

Short note shown next to the status. The Phone shows it only with the system Idle type (id 9). The mobile app, and the notice that tells the user an admin changed their status, show it with any type.

Example:

"Back at 14:00"

presence
enum<string>
required

connected when the user is signed in on at least one device.

Available options:
connected,
disconnected
source
enum<string>
required

Who set the current statusType: the user, an admin in the Dashboard, or this API. A user who never picked a status shows user. After an API change, api stays until the user or an admin picks a status.

Available options:
user,
admin,
api
updatedAt
string<date-time>
required

Last time the user's connection, call state or picked status changed. UTC with milliseconds, for example 2026-11-02T12:58:40.731Z.