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

# Fetch collections

> Fetches the catalog collections for a business WhatsApp number.



## OpenAPI

````yaml openapi.evolution-v2.json POST /business/getCollections/{instance}
openapi: 3.1.0
info:
  title: Evolution V2 Layer
  version: 1.0.0
  description: >-
    Pilot Status API Layer — Evolution V2. Base URL
    `https://pilotstatus.com.br/api/layer/evolution-v2`. Authenticate with the
    `apikey` header (your Pilot Status `ps_` key). Instance/session endpoints
    are NOT available through the layer.
servers:
  - url: https://pilotstatus.com.br/api/layer/evolution-v2
security:
  - apiKey: []
tags:
  - name: Call & Business
  - name: Chat
  - name: Group
  - name: Label
  - name: Message
  - name: Profile
  - name: Settings & Proxy
  - name: Storage (S3)
  - name: Template
paths:
  /business/getCollections/{instance}:
    post:
      tags:
        - Call & Business
      summary: Fetch collections
      description: Fetches the catalog collections for a business WhatsApp number.
      operationId: post__business_getCollections_instance
      parameters:
        - name: instance
          in: path
          required: true
          schema:
            type: string
          description: The number's display name in the Pilot Status dashboard.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                number:
                  type: string
                  description: >-
                    Business phone number whose collections to fetch; defaults
                    to the instance's own number.
                  example: '5511999999999'
                limit:
                  type: number
                  description: Maximum number of collections to return.
                  example: 20
      responses:
        '200':
          description: Success — provider-native response body.
          content:
            application/json:
              schema:
                type: object
                description: Product collections fetched from a WhatsApp Business account.
                properties:
                  wuid:
                    type: string
                    description: Resolved WhatsApp JID of the queried business number.
                  name:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Display name associated with the queried number, if
                      available.
                  numberExists:
                    type: boolean
                    description: Whether the queried number exists on WhatsApp.
                  isBusiness:
                    type: boolean
                    description: Whether the number is a WhatsApp Business account.
                  collectionsLength:
                    type: integer
                    description: Number of collections returned in the collections array.
                  collections:
                    type: array
                    description: List of catalog collections.
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Collection id.
                        name:
                          type: string
                          description: Collection name.
                        status:
                          type: string
                          description: Review/publish status of the collection.
                        products:
                          type: array
                          description: Products contained in this collection.
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                description: Product id.
                              name:
                                type: string
                                description: Product name.
                              description:
                                type: string
                                description: Product description.
                              price:
                                type: integer
                                description: >-
                                  Price in the smallest currency unit (e.g.
                                  cents).
                              currency:
                                type: string
                                description: ISO 4217 currency code.
                              retailerId:
                                type: string
                                description: Retailer-defined SKU / content id.
                              url:
                                type: string
                                description: Product landing URL.
                              isHidden:
                                type: boolean
                                description: >-
                                  Whether the product is hidden from the
                                  storefront.
                              availability:
                                type: string
                                description: >-
                                  Stock availability, e.g. 'in stock', 'out of
                                  stock'.
                              imageUrls:
                                type: object
                                description: Map of image size key to image URL.
                                additionalProperties:
                                  type: string
                              reviewStatus:
                                type: object
                                description: Map of review dimension to review status.
                                additionalProperties:
                                  type: string
                required:
                  - wuid
                  - numberExists
                  - isBusiness
                  - collectionsLength
                  - collections
              example:
                wuid: 5511999999999@s.whatsapp.net
                name: Loja Exemplo
                numberExists: true
                isBusiness: true
                collectionsLength: 1
                collections:
                  - id: '434823429384756'
                    name: Lançamentos
                    status: APPROVED
                    products:
                      - id: '6104474702914109'
                        name: Camiseta Pilot Status
                        description: Camiseta 100% algodão, edição limitada.
                        price: 7990
                        currency: BRL
                        retailerId: SKU-TSHIRT-001
                        url: https://loja.exemplo.com.br/camiseta
                        isHidden: false
                        availability: in stock
                        imageUrls:
                          requested_image_size: >-
                            https://mmg.whatsapp.net/v/t45.5328-4/prod1_thumb.jpg
                        reviewStatus:
                          whatsapp: APPROVED
        default:
          description: Error — provider or layer error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  response:
                    type: object
              example:
                status: 400
                error: Bad Request
                message: Invalid payload
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: >-
        Your Pilot Status API key (ps_...). Evolution GO also accepts
        `Authorization: Bearer <key>`.

````