Skip to main content
GET
Get an inbox

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

inboxId
integer
required

The id returned when the inbox was created or listed.

Example:

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.

id
integer
required
Example:

3

name
string
required
Example:

"Support WhatsApp"

channel_type
string | null
required

The fully qualified channel class, e.g. Channel::Whatsapp, Channel::WebWidget, Channel::Api, Channel::FacebookPage, Channel::TwilioSms.

Example:

"Channel::Whatsapp"

greeting_enabled
boolean | null
required
Example:

true

greeting_message
string | null
required
Example:

"Thanks for reaching out! We'll be with you shortly."

working_hours_enabled
boolean | null
required
Example:

true

out_of_office_message
string | null
required
Example:

"We're closed right now — we'll reply as soon as we're back."

timezone
string | null
required
Example:

"America/Sao_Paulo"

csat_survey_enabled
boolean | null
required
Example:

true

enable_auto_assignment
boolean | null
required
Example:

true

allow_messages_after_resolved
boolean | null
required
Example:

true

lock_to_single_conversation
boolean
required
Example:

false

created_at
string<date-time>
required
Example:

"2026-05-02T11:04:17.000Z"

updated_at
string<date-time>
required
Example:

"2026-08-10T14:32:05.123Z"