Skip to navigation

Get a member's availability

Whether the member takes transferred calls: available, away or offline (with the end time, who set it, and whether they are on a call right now). An away/offline whose end time passed reads as available.

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Path parameters

memberIdstringRequiredformat: "uuid"
Membership ID

Response

The member's availability
busyboolean

On a transferred call right now; not offered another one

memberIdstringformat: "uuid"
Membership ID
statusenum

The status in force now (an away/offline whose end time passed reads as available)

Allowed values:
userIdstringformat: "uuid"
User ID
reasonstring or nullOptional

Why the platform set it (missed_calls), with source: auto

sourceenum or nullOptional

Who set the status: the member, an owner/admin, or the platform (auto, after missed calls).

Allowed values:
untildatetime or nullOptional

When away/offline ends by itself; null = until changed

updatedAtdatetime or nullOptional

When the current away/offline was set

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error