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

# List inboxes you can query

> Returns the email and phone/SMS inboxes available to the credential, for use
as the `channelId` on the messages and analytics endpoints.

With delegate-token auth (`inboxes:*` scope) results are limited to
inboxes the authenticated user can reach, and each entry carries `access`:
`owned` when the user is a member of the inbox (directly or through a team),
`monitored` when it is another user's private inbox that the caller is
permitted to monitor. `scope` filters on that value.

Monitoring requires the `conversations.monitor_admin` permission on the
caller and `conversations.monitor_access` on the inbox owner's role, so a
caller without those permissions sees only `owned` inboxes.

API keys and partner tokens are company-scoped and carry no user identity, so
they return every inbox in the company, omit `access`, and reject `scope`
with a `400`.




## OpenAPI

````yaml /openapi.yaml get /api/inboxes
openapi: 3.0.3
info:
  title: Aptly API
  version: '1.0'
  description: >
    The Aptly API lets you read and write cards on any Aptly board from external
    systems.


    All requests require an API key passed as the `x-token` header.

    API keys are scoped to your company and work across all boards.
servers:
  - url: https://core-api.getaptly.com
    description: Production
security:
  - ApiKeyHeader: []
paths:
  /api/inboxes:
    get:
      tags:
        - Inboxes
      summary: List inboxes you can query
      description: >
        Returns the email and phone/SMS inboxes available to the credential, for
        use

        as the `channelId` on the messages and analytics endpoints.


        With delegate-token auth (`inboxes:*` scope) results are limited to

        inboxes the authenticated user can reach, and each entry carries
        `access`:

        `owned` when the user is a member of the inbox (directly or through a
        team),

        `monitored` when it is another user's private inbox that the caller is

        permitted to monitor. `scope` filters on that value.


        Monitoring requires the `conversations.monitor_admin` permission on the

        caller and `conversations.monitor_access` on the inbox owner's role, so
        a

        caller without those permissions sees only `owned` inboxes.


        API keys and partner tokens are company-scoped and carry no user
        identity, so

        they return every inbox in the company, omit `access`, and reject
        `scope`

        with a `400`.
      operationId: listInboxes
      parameters:
        - name: scope
          in: query
          schema:
            type: string
            enum:
              - owned
              - monitored
              - all
            default: all
          description: >-
            Filter by access type. Delegate-token auth only — rejected for
            company-scoped credentials.
      responses:
        '200':
          description: Inboxes available to the credential.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        channelId:
                          type: string
                          description: >-
                            External channel meta ID (`meta.id`). Use this on
                            the other inbox endpoints.
                        type:
                          type: string
                          enum:
                            - email
                            - phone
                        provider:
                          type: string
                          nullable: true
                          description: >-
                            Underlying provider, e.g. `gmail`, `office365`,
                            `twilio`.
                        name:
                          type: string
                          nullable: true
                        email:
                          type: string
                          nullable: true
                          description: Set for email inboxes.
                        number:
                          type: string
                          nullable: true
                          description: Set for phone/SMS inboxes.
                        isShared:
                          type: boolean
                        access:
                          type: string
                          enum:
                            - owned
                            - monitored
                          description: >-
                            Present only with delegate-token auth. `owned` = the
                            user is a member of the inbox; `monitored` = another
                            user's private inbox the caller may monitor.
        '400':
          description: Invalid `scope`, or `scope` used with a company-scoped credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Invalid or missing credential.
      security:
        - ApiKeyHeader: []
        - DelegateToken: []
        - PartnerBearer: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-token
    DelegateToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'Delegate token issued by the platform. Format: `DelegateToken <token>`'
    PartnerBearer:
      type: http
      scheme: bearer
      description: 'Partner token. Format: `Authorization: Bearer <token>`'

````