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

# List inboxes

> Lists the inboxes the calling operator may see — the conversation sidebar.

The result mixes the tenant's own inboxes with the four universal defaults
("Acontecendo agora", "Fila", "Meus atendimentos", "Histórico"), which are
synthesised rather than stored and always sort first.

Each row carries **two** visibilities: `inboxVisibility` is what the tenant
configured, `__inboxVisibility` is what this operator sees after their role
and access grants are applied. Owners, managers and superusers see every
inbox; everyone else sees the public and locked ones plus whatever they
were granted explicitly. Rows that resolve to `hidden` are omitted.



## OpenAPI

````yaml /api/services-api.yaml get /v1/tenants/{tenantID}/inboxes
openapi: 3.0.3
info:
  description: >-
    Talqui is an omnichannel customer service platform that unifies
    conversations from WhatsApp, Instagram, Telegram, and many other channels
    into a single attendant panel, alongside a broader ecosystem of plugins and
    integrations. This API gives developers programmatic access to Talqui's
    services layer, exposing the operations needed to read and manage tenants,
    conversations, plugins, and related resources that power that platform.


    Authentication is available on behalf of an Operator (the default for this
    API), a Plugin Connection, or a Plugin — see the [Talqui authentication
    guide](https://docs.talqui.chat/guides/introduction/authentication/) for how
    each token is obtained and when to use it.


    Need help or have questions not covered here? Reach out to
    support@talqui.com.
  license:
    name: ISC
    url: https://opensource.org/license/isc-license-txt
  title: Talqui - Services API
  version: 0.65.0
servers:
  - description: Production
    url: https://services-api.talqui.chat
security: []
tags:
  - name: Tenants
  - name: Settings
  - name: Analytics
  - name: Campaigns
  - name: Campaigns models
  - name: Contacts
  - name: Handoff links
  - name: Inboxes
  - name: Messages
  - name: Notifications
  - name: Sessions
  - name: Operators
  - name: Plugins
  - name: Setup
  - name: Uploads
paths:
  /v1/tenants/{tenantID}/inboxes:
    get:
      tags:
        - Inboxes
      summary: List inboxes
      description: >-
        Lists the inboxes the calling operator may see — the conversation
        sidebar.


        The result mixes the tenant's own inboxes with the four universal
        defaults

        ("Acontecendo agora", "Fila", "Meus atendimentos", "Histórico"), which
        are

        synthesised rather than stored and always sort first.


        Each row carries **two** visibilities: `inboxVisibility` is what the
        tenant

        configured, `__inboxVisibility` is what this operator sees after their
        role

        and access grants are applied. Owners, managers and superusers see every

        inbox; everyone else sees the public and locked ones plus whatever they

        were granted explicitly. Rows that resolve to `hidden` are omitted.
      operationId: ListInboxesController
      parameters:
        - in: path
          name: tenantID
          required: true
          schema:
            description: The tenant whose inboxes are being listed.
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            type: string
        - in: query
          name: inboxStatus
          required: false
          schema:
            default: active
            description: Which inboxes to list. Defaults to the ones in use.
            enum:
              - active
              - archived
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    additionalProperties: false
                    properties:
                      inboxes:
                        description: >-
                          Inboxes visible to the calling operator, defaults
                          first.
                        items:
                          additionalProperties: false
                          properties:
                            __inboxOperatorIDs:
                              description: >-
                                Operators holding an explicit access grant to
                                this inbox.
                              items:
                                type: string
                              type: array
                            __inboxVisibility:
                              description: >-
                                Visibility **this operator** sees, after role
                                and access grants. Never `hidden` — those rows
                                are omitted.
                              enum:
                                - visible
                                - locked
                                - hidden
                              type: string
                            createdAt:
                              description: Absent on the default inboxes.
                              format: date-time
                              type: string
                            inboxAutoRouting:
                              description: >-
                                Whether sessions entering this inbox are
                                auto-assigned to an operator with access.
                              type: boolean
                            inboxFilters:
                              description: >-
                                Filters applied to the session list when this
                                inbox is selected.
                              items:
                                additionalProperties: false
                                properties:
                                  criterion:
                                    description: The field being filtered.
                                    type: string
                                  enforced:
                                    description: >-
                                      Whether the filter is applied server-side
                                      and cannot be dropped.
                                    type: boolean
                                  id:
                                    description: >-
                                      Stable identifier of the filter within the
                                      inbox.
                                    type: string
                                  operator:
                                    description: >-
                                      Comparison operator, e.g. `eq`, `ha`,
                                      `gt`.
                                    type: string
                                  query:
                                    description: >-
                                      Values compared against. `$me` resolves to
                                      the calling operator.
                                    items: {}
                                    type: array
                                  schema:
                                    description: >-
                                      Which document the criterion applies to:
                                      `session` or `contact`.
                                    type: string
                                required:
                                  - schema
                                  - criterion
                                  - operator
                                  - query
                                type: object
                              type: array
                            inboxID:
                              description: The inbox identifier.
                              type: string
                            inboxMetadata:
                              additionalProperties: {}
                              description: Arbitrary metadata attached to the inbox.
                              type: object
                            inboxName:
                              description: Display name.
                              type: string
                            inboxPriority:
                              description: >-
                                Sort weight, descending. The defaults sit above
                                anything a tenant sets.
                              type: number
                            inboxStatus:
                              description: Whether the inbox is in use or archived.
                              enum:
                                - active
                                - archived
                              type: string
                            inboxVisibility:
                              description: >-
                                Visibility the tenant **configured** for this
                                inbox.
                              enum:
                                - visible
                                - locked
                                - hidden
                              type: string
                            tenantID:
                              description: Absent on the four synthesised default inboxes.
                              type: string
                            updatedAt:
                              description: Absent on the default inboxes.
                              format: date-time
                              type: string
                          required:
                            - inboxID
                            - inboxName
                            - inboxStatus
                            - inboxPriority
                            - inboxFilters
                            - inboxMetadata
                            - inboxVisibility
                            - __inboxVisibility
                            - __inboxOperatorIDs
                          type: object
                        type: array
                    required:
                      - inboxes
                    type: object
                required:
                  - data
                type: object
          description: Response for status 200.
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      oneOf:
                        - $ref: '#/components/schemas/MissingTenantIDError'
                        - $ref: '#/components/schemas/MissingOperatorIDError'
                        - $ref: '#/components/schemas/RequestValidationError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            MissingTenantIDError (error_code 1001): tenantID absent from the
            URL. | MissingOperatorIDError (error_code 1063): the resolved
            identity carries no operatorID. | RequestValidationError (error_code
            1002): params or query fail schema validation.
        '401':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/UnauthorizedError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: 'UnauthorizedError (error_code 1003): missing/invalid operator token.'
        '403':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/ForbiddenError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            ForbiddenError (error_code 1004): operator does not belong to this
            tenant.
        '404':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/TenantNotFoundError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            TenantNotFoundError (error_code 1062): tenantID does not resolve to
            a tenant.
        '500':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/UnknownError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            UnknownError (error_code 5999): Unexpected internal error not
            otherwise documented for this endpoint.
components:
  schemas:
    MissingTenantIDError:
      additionalProperties: false
      properties:
        error:
          enum:
            - MissingTenantIDError
          type: string
        error_code:
          enum:
            - 1001
          type: number
        message:
          example: tenantID is required.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    MissingOperatorIDError:
      additionalProperties: false
      properties:
        error:
          enum:
            - MissingOperatorIDError
          type: string
        error_code:
          enum:
            - 1063
          type: number
        message:
          example: operatorID is required.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    RequestValidationError:
      additionalProperties: false
      properties:
        error:
          enum:
            - RequestValidationError
          type: string
        error_code:
          enum:
            - 1002
          type: number
        fields:
          items:
            additionalProperties: false
            properties:
              allowed:
                type: string
              field:
                type: string
              received:
                type: string
            required:
              - field
              - received
              - allowed
            type: object
          type: array
        message:
          example: Invalid request data.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
        - fields
      type: object
    UnauthorizedError:
      additionalProperties: false
      properties:
        error:
          enum:
            - UnauthorizedError
          type: string
        error_code:
          enum:
            - 1003
          type: number
        message:
          example: You are not authorized to perform this request.
          type: string
        statusCode:
          enum:
            - 401
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    ForbiddenError:
      additionalProperties: false
      properties:
        error:
          enum:
            - ForbiddenError
          type: string
        error_code:
          enum:
            - 1004
          type: number
        message:
          example: You do not have access to this resource.
          type: string
        statusCode:
          enum:
            - 403
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    TenantNotFoundError:
      additionalProperties: false
      properties:
        error:
          enum:
            - TenantNotFoundError
          type: string
        error_code:
          enum:
            - 1062
          type: number
        message:
          example: Tenant not found.
          type: string
        statusCode:
          enum:
            - 404
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    UnknownError:
      additionalProperties: false
      properties:
        error:
          enum:
            - UnknownError
          type: string
        error_code:
          enum:
            - 5999
          type: number
        message:
          example: For some unknown reason your request has not succeeded.
          type: string
        statusCode:
          enum:
            - 500
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object

````

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