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

# List Collections

> List collections, optionally filtered to one partner user.



## OpenAPI

````yaml get /v1/collections
openapi: 3.1.0
info:
  title: Channel3 API
  version: 0.1.0
servers:
  - url: https://api.trychannel3.com
    description: Production
security: []
paths:
  /v1/collections:
    get:
      tags:
        - collections
      summary: List Collections
      description: List collections, optionally filtered to one partner user.
      operationId: list_collections_v1_collections_get
      parameters:
        - name: user_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Optional partner user id. When provided, returns only that user's
              collections. When omitted, returns all collections for this API
              key.
            title: User Id
          description: >-
            Optional partner user id. When provided, returns only that user's
            collections. When omitted, returns all collections for this API key.
        - name: page_token
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Opaque token from a previous list response.
            title: Page Token
          description: Opaque token from a previous list response.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 50
            title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCollectionsResponse'
        '401':
          description: Unauthorized - Invalid or missing authentication
          content:
            application/json:
              examples:
                missing_key:
                  summary: Missing API Key
                  value:
                    detail: >-
                      Unauthorized. Missing authentication key. Make sure to
                      attach an x-api-key with your request. Need help? Reach
                      out to support@channel3.ai.
                invalid_key:
                  summary: Invalid API Key
                  value:
                    detail: >-
                      API key was provided but is invalid. Need help? Reach out
                      to support@channel3.ai.
              schema:
                $ref: '#/components/schemas/app__routers__utils__ErrorResponse'
        '402':
          description: Payment required
          content:
            application/json:
              examples:
                credits_exhausted:
                  summary: API key out of credits
                  value:
                    detail: >-
                      You have used all of your free credits. Add a payment
                      method to continue.
                mpp_challenge:
                  summary: MPP Tempo payment required
                  value:
                    detail: >-
                      Payment required. Satisfy the MPP Tempo challenge in
                      WWW-Authenticate.
              schema:
                $ref: '#/components/schemas/app__routers__utils__ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/app__routers__utils__ErrorResponse'
              example:
                detail:
                  - loc:
                      - body
                      - query
                    msg: field required
                    type: value_error.missing
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/app__routers__utils__ErrorResponse'
              example:
                detail: Internal Server Error
      security:
        - APIKeyHeader: []
      x-codeSamples:
        - lang: python
          label: Python
          source: |
            from channel3_sdk import Channel3
            from channel3_sdk.environment import Channel3Environment

            client = Channel3(
                api_key="<value>",
                environment=Channel3Environment.PRODUCTION,
            )

            client.collections.list()
        - lang: typescript
          label: TypeScript
          source: |
            import { Channel3 } from "@channel3/sdk";

            const client = new Channel3({ apiKey: "YOUR_API_KEY" });

            const pageableResponse = await client.collections.list();
            for await (const item of pageableResponse) {
                console.log(item);
            }

            // Or you can manually iterate page-by-page
            let page = await client.collections.list();
            while (page.hasNextPage()) {
                page = page.getNextPage();
            }

            // You can also access the underlying response
            const response = page.response;
components:
  schemas:
    PaginatedCollectionsResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/CollectionResponse'
          type: array
          title: Items
        next_page_token:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Page Token
      type: object
      required:
        - items
      title: PaginatedCollectionsResponse
    app__routers__utils__ErrorResponse:
      properties:
        detail:
          anyOf:
            - type: string
            - items:
                additionalProperties: true
                type: object
              type: array
          title: Detail
      type: object
      required:
        - detail
      title: ErrorResponse
    CollectionResponse:
      properties:
        collection_id:
          type: string
          title: Collection Id
        name:
          type: string
          title: Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: User Id
        clauses:
          items:
            $ref: '#/components/schemas/CollectionClause'
          type: array
          title: Clauses
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - collection_id
        - name
        - clauses
        - created_at
        - updated_at
      title: CollectionResponse
    CollectionClause:
      properties:
        brand_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Brand Ids
          description: >-
            OR within this list (any slot). AND with the clause's other lists.
            OR against other clauses.
        website_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Website Ids
          description: >-
            Merchant ids; OR within this list (any matching offer). AND with the
            clause's other lists. Domains are accepted on write and stored as
            merchant ids. Also scopes displayed offers for products matched only
            by website-scoped clauses.
        category_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Category Ids
          description: OR within this list. AND with the clause's other lists.
        product_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Product Ids
        exclude_brand_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Exclude Brand Ids
          description: Clause-only; products missing a brand id still match.
        exclude_website_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Exclude Website Ids
          description: Clause-only; domains become ids; another offer keeps the product.
        exclude_category_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Exclude Category Ids
          description: Clause-only; products missing category_ids still match.
        clause_id:
          type: string
          title: Clause Id
      additionalProperties: false
      type: object
      required:
        - clause_id
      title: CollectionClause
      description: Persisted clause with a stable server-minted id.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````

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