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

# List Collections

> List collections, optionally filtered to one partner user. Collection CRUD is free.



## OpenAPI

````yaml get /v1/collections
openapi: 3.1.0
info:
  title: FastAPI
  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. Collection
        CRUD is free.
      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
        - name: page_token
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Opaque token from a previous list response.
            title: Page Token
        - 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@trychannel3.com.
                invalid_key:
                  summary: Invalid API Key
                  value:
                    detail: >-
                      API key was provided but is invalid. Need help? Reach out
                      to support@trychannel3.com.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - APIKeyHeader: []
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
    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:
      allOf:
        - $ref: '#/components/schemas/CollectionClauseInput'
        - type: object
          required:
            - clause_id
          properties:
            clause_id:
              type: string
              title: Clause Id
      title: CollectionClause
      description: Persisted clause with a stable server-minted id.
    CollectionClauseInput:
      properties:
        brand_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Brand Ids
          description: >-
            OR within this list. 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 domains; OR within this list. AND with the clause's
            other lists. Domains are stored as merchant ids.
        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
      additionalProperties: false
      type: object
      title: CollectionClauseInput
      description: Clause payload for create / add_clauses (server mints clause_id).
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````