50 lines
1.2 KiB
YAML
50 lines
1.2 KiB
YAML
get:
|
|
tags:
|
|
- Inboxes
|
|
operationId: GetInbox
|
|
summary: Get an inbox
|
|
security:
|
|
- userApiKey: []
|
|
description: Get an inbox available in the current account
|
|
parameters:
|
|
- $ref: '#/components/parameters/account_id'
|
|
- name: id
|
|
in: path
|
|
schema:
|
|
type: number
|
|
description: ID of the inbox
|
|
required: true
|
|
x-codeSamples:
|
|
- lang: python
|
|
label: "Get an inbox"
|
|
source: |
|
|
from chatwoot import ChatwootClient
|
|
|
|
client = ChatwootClient(
|
|
base_url="https://app.chatwoot.com",
|
|
api_token="your-api-token"
|
|
)
|
|
|
|
inbox = client.inboxes.get(account_id=1, inbox_id=5)
|
|
|
|
print(inbox.name, inbox.channel_type)
|
|
responses:
|
|
'200':
|
|
description: Success
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/inbox'
|
|
'404':
|
|
description: Inbox not found
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/bad_request_error'
|
|
'403':
|
|
description: Access denied
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/bad_request_error'
|