Skip to main content
GET
Get an agent's hub access

Authorizations

Authorization
string
header
required

The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.

Headers

cloudchat-instance
integer
required

Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.

Example:

1

Path Parameters

accountId
integer
required

Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.

Example:

1

agentId
integer
required

The agent's user id, as returned when the agent was listed. A hidden admin's id answers 404 here, the same as an id that does not exist.

Example:

7

Response

agent_access is what agentId currently holds; manageable is your own ceiling for this account — the exact set this credential can grant or revoke via setAgentAccess.

An agent's hub access, alongside the caller's own ceiling for granting or revoking it.

agent_access
object
required

What the agent in the path currently holds.

manageable
object
required

The caller's own ceiling — the exact set this credential can grant or revoke.