Get an inbox
A single inbox by id. Answers 404 for an inbox outside the token’s reach (an agent that is not a member of it), the same as for an id that does not exist. No channel credential is ever included.
Authorizations
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
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.
1
Path Parameters
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.
1
The id returned when the inbox was created or listed.
3
Response
The inbox.
An inbox of the account. Configuration only — no channel credential (access token, phone number id, API key, or similar) is ever included in this payload, on any channel type.
3
"Support WhatsApp"
The fully qualified channel class, e.g. Channel::Whatsapp, Channel::WebWidget, Channel::Api, Channel::FacebookPage, Channel::TwilioSms.
"Channel::Whatsapp"
true
"Thanks for reaching out! We'll be with you shortly."
true
"We're closed right now — we'll reply as soon as we're back."
"America/Sao_Paulo"
true
true
true
false
"2026-05-02T11:04:17.000Z"
"2026-08-10T14:32:05.123Z"