Skip to main content
GET
Get inbox by ID

Authorizations

Authorization
string
header
required

Token JWT de autenticação

Headers

x-company-id
string

Target company identifier. Required only for global API keys (type=global). Ignored for company API keys and human users.

Path Parameters

id
string
required

Inbox ID

Response

Inbox found successfully

name
string
required

Inbox name

number
string
required

Inbox's phone number

company
any
required

Company that owns the inbox

channel
string
required

Communication channel (WAP_AUTO_CLOSER, etc.)

status
enum<string>
required

Inbox status (ACTIVE, DELETED)

Available options:
ACTIVE,
DELETED
_id
string

Inbox ID

webhook_url
string

Webhook URL for notifications

test_mode
object

Test mode settings

default_agent
any

Default agent for new conversations

api_wap_config
object

WhatsApp Business API settings (channel only)

evolution_api_config
object

Evolution API settings

linkedin_config
object

LinkedIn settings (Unipile)

general_config
object

General inbox settings

coexistence_enabled
boolean

Enables ingestion of smb_message_echoes (WhatsApp Coexistence).

process_unsupported_messages
boolean

Allows UNSUPPORTED messages from Meta to follow the agent's normal flow.

disable_inbound_ai
boolean

Opt-in. When true, the AI does not handle organic inbound (new conversations for human handling); the AI keeps handling campaign leads.

pdf_local_text_extraction
boolean

Opt-in for the hybrid PDF reading mode. When true, the text is extracted locally and the AI receives the TEXT instead of the image (it stays in the loop, just reorganizing it): no size limit and no vision tokens. Falls back to the vision path when local reading doesn't work (scanned PDF, non-PDF, unreadable). Default false.

default_owner
string | null

ID of the default owner user for new conversations in this inbox (opt-in). Null = no default owner.

createdAt
any

Inbox creation date

updatedAt
any

Inbox update date