Skip to main content
GET
Get team availability
Returns the same lists as the Team availability screen: who is Active or Away and why, the leads waiting for a person, and the stages that assign leads. Use it to check why a lead went to someone, or why nobody got it. See Assign leads only to Active team members for how the rule works.

Before you start

  • MCP keys need people:read. Full-access REST keys need nothing else.
  • A key that belongs to a person (for example an MCP key) works only for owners and admins. Otherwise it returns 403 OWNER_OR_ADMIN_REQUIRED.
  • If team availability is not turned on for the account, it returns 403 TEAM_AVAILABILITY_UNAVAILABLE.
  • It is read-only. Errors return a stable code in error. Map the code to your own copy.

What you get back

Each member

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Response

Team availability for the account.

idle_minutes
integer
required

Minutes without using the app before a member is set Away automatically. Default 50.

Required range: 10 <= x <= 480
members
object[]
required

Active members of the account (owners, admins and human agents).

waiting_leads
object[]
required

Leads that entered a stage when nobody in its list was Active and still have no owner. Oldest first, at most 100.

Maximum array length: 100
stages
object[]
required

Stages that assign leads, with or without the Active-only rule.

Last modified on October 21, 2026