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

# List WhatsApp media collections

**Required scope:** `whatsapp.view`


## OpenAPI

````yaml /api-reference/openapi.json get /whatsapp/collections
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /whatsapp/collections:
    get:
      summary: List WhatsApp media collections
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  collections:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        tag:
                          type: string
                        description:
                          type: string
                          nullable: true
                        caption:
                          type: string
                          nullable: true
                        itemCount:
                          type: number
                        items:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              kind:
                                type: string
                                enum:
                                  - TEXT
                                  - IMAGE
                                  - DOCUMENT
                                  - VIDEO
                                  - AUDIO
                              fileName:
                                type: string
                                nullable: true
                              mimeType:
                                type: string
                                nullable: true
                              sizeBytes:
                                type: number
                                nullable: true
                              caption:
                                type: string
                                nullable: true
                              isUploaded:
                                type: boolean
                              url:
                                type: string
                                nullable: true
                              sortOrder:
                                type: number
                              createdAt:
                                type: string
                            required:
                              - id
                              - kind
                              - fileName
                              - mimeType
                              - sizeBytes
                              - caption
                              - isUploaded
                              - url
                              - sortOrder
                              - createdAt
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                        templateId:
                          type: string
                          nullable: true
                        templateHeaderItemId:
                          type: string
                          nullable: true
                        templateSendMode:
                          type: string
                          enum:
                            - SINGLE
                            - ALL
                      required:
                        - id
                        - tag
                        - description
                        - caption
                        - itemCount
                        - items
                        - createdAt
                        - updatedAt
                        - templateId
                        - templateHeaderItemId
                        - templateSendMode
                required:
                  - collections
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

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