> ## Documentation Index
> Fetch the complete documentation index at: https://docs.evolutionfoundation.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an inbox

> Get an inbox available in the current account



## OpenAPI

````yaml /api-reference/openapi/EvoAI-CRM-Service/inboxes.yaml get /api/v1/inboxes/{id}
openapi: 3.0.4
info:
  title: Evolution Foundation - CRM Service - Inboxes
  description: Management of contacts, conversations, inboxes, labels and macros
  version: 1.1.0
servers:
  - url: https://api.evoai.app
    description: Production server
  - url: http://localhost:3000
    description: Development server
    variables:
      port:
        default: '3000'
  - url: '{customUrl}'
    description: Custom server
    variables:
      customUrl:
        default: https://your-instance.com
        description: Enter your server URL
security: []
paths:
  /api/v1/inboxes/{id}:
    parameters:
      - name: id
        in: path
        schema:
          type: string
          format: uuid
        description: ID of the inbox
        required: true
    get:
      summary: Get an inbox
      description: Get an inbox available in the current account
      operationId: GetInbox
      responses:
        '200':
          description: Inbox retrieved successfully
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - meta
                  - message
                properties:
                  success:
                    type: boolean
                    example: true
                  data: dd9e0426-6a2c-4157-868d-03bd688a9efd
                  meta:
                    type: object
                    properties:
                      timestamp:
                        type: string
                        format: date-time
                        description: Response timestamp
                        example: '2024-01-15T10:30:00Z'
                  message:
                    type: string
                    description: Success message
                    example: Inbox retrieved successfully
              example:
                success: true
                data:
                  id: 01d9f573-f953-4210-a99a-cdd3bd7f37a6
                  channel_id: d6b55c22-03c4-4778-a6d9-2d7b63e602f4
                  name: davidson-gomes
                  channel_type: Channel::Whatsapp
                  enable_auto_assignment: true
                  greeting_enabled: false
                  greeting_message: null
                  working_hours_enabled: false
                  out_of_office_message: null
                  timezone: UTC
                  enable_email_collect: true
                  csat_survey_enabled: false
                  allow_messages_after_resolved: true
                  auto_assignment_config: {}
                  lock_to_single_conversation: false
                  csat_config: {}
                  sender_name_type: friendly
                  business_name: null
                  display_name: Davidson Gomes
                  default_conversation_status: null
                  avatar_url: ''
                  working_hours:
                    - day_of_week: 0
                      closed_all_day: true
                      open_hour: null
                      open_minutes: null
                      close_hour: null
                      close_minutes: null
                      open_all_day: false
                    - day_of_week: 1
                      closed_all_day: false
                      open_hour: 9
                      open_minutes: 0
                      close_hour: 17
                      close_minutes: 0
                      open_all_day: false
                    - day_of_week: 2
                      closed_all_day: false
                      open_hour: 9
                      open_minutes: 0
                      close_hour: 17
                      close_minutes: 0
                      open_all_day: false
                    - day_of_week: 3
                      closed_all_day: false
                      open_hour: 9
                      open_minutes: 0
                      close_hour: 17
                      close_minutes: 0
                      open_all_day: false
                    - day_of_week: 4
                      closed_all_day: false
                      open_hour: 9
                      open_minutes: 0
                      close_hour: 17
                      close_minutes: 0
                      open_all_day: false
                    - day_of_week: 5
                      closed_all_day: false
                      open_hour: 9
                      open_minutes: 0
                      close_hour: 17
                      close_minutes: 0
                      open_all_day: false
                    - day_of_week: 6
                      closed_all_day: true
                      open_hour: null
                      open_minutes: null
                      close_hour: null
                      close_minutes: null
                      open_all_day: false
                  created_at: 1769624054
                  updated_at: 1769624054
                  provider: whatsapp_cloud
                meta:
                  timestamp: '2026-02-05T16:18:53Z'
                message: Inbox retrieved successfully
        '400':
          description: Bad Request (invalid data)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                bad_request:
                  summary: Invalid request data
                  value:
                    success: false
                    error:
                      code: BAD_REQUEST
                      message: Invalid request data
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/inboxes/{id}
                      method: GET
        '401':
          description: Unauthorized (invalid or missing token)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized
                  value:
                    success: false
                    error:
                      code: UNAUTHORIZED
                      message: Unauthorized
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/inboxes/{id}
                      method: GET
        '403':
          description: Forbidden (insufficient permissions)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                forbidden:
                  summary: Forbidden
                  value:
                    success: false
                    error:
                      code: FORBIDDEN
                      message: Forbidden
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/inboxes/{id}
                      method: GET
        '404':
          description: Not Found (resource not found)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                not_found:
                  summary: Inbox not found
                  value:
                    success: false
                    error:
                      code: NOT_FOUND
                      message: Inbox not found
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/inboxes/{id}
                      method: GET
        '500':
          description: Internal Server Error (server error)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                internal_error:
                  summary: Internal server error
                  value:
                    success: false
                    error:
                      code: INTERNAL_ERROR
                      message: An internal server error occurred
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/inboxes/{id}
                      method: GET
      security:
        - userApiKey: []
components:
  schemas:
    ErrorResponse:
      type: object
      required:
        - success
        - error
        - meta
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: VALIDATION_ERROR
            message:
              type: string
              example: Validation failed
            details:
              type: object
              additionalProperties: true
              nullable: true
        meta:
          type: object
          required:
            - timestamp
            - path
            - method
          properties:
            timestamp:
              type: string
              format: date-time
              example: '2024-01-15T10:30:00Z'
            path:
              type: string
              example: /public/api/v1/inboxes/{inbox_identifier}/contacts
            method:
              type: string
              example: POST
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.