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

# List brands

> Returns the brands you can read, newest first.



## OpenAPI

````yaml /brand-api/openapi.json get /brands
openapi: 3.1.0
info:
  title: Clipstake Brand API
  description: >-
    Read the brands, campaigns and clips of your Clipstake account. The API is
    read-only.
  version: 0.1.0
servers:
  - url: https://app.clipstake.com/api/v1/brand
security: []
paths:
  /brands:
    get:
      tags:
        - Brands
      summary: List brands
      description: Returns the brands you can read, newest first.
      operationId: brands-list
      parameters:
        - in: query
          name: limit
          schema:
            default: 25
            description: How many items to return, from 1 to 100. The default is 25.
            example: 25
            type: integer
            minimum: 1
            maximum: 100
        - in: query
          name: cursor
          schema:
            type: string
            description: >-
              The `next_cursor` from the previous page. Send it with the same
              filters as that request.
            example: MTc1OTgyMDQwMDAwMC5hYmMuMTIzNDU2Nzg5MGFi
        - in: query
          name: status
          schema:
            type: string
            enum:
              - active
              - inactive
            description: '`active` brands can run campaigns. `inactive` brands are archived.'
            example: active
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          pattern: ^brd_[0-9a-f]{32}$
                          description: Brand ID.
                          example: brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7
                        name:
                          type: string
                          description: The brand name.
                          example: Northwind Coffee
                        description:
                          description: The brand description, if one was set.
                          example: Specialty coffee roasted in small batches.
                          type:
                            - string
                            - 'null'
                        website_url:
                          description: The brand website, if one was set.
                          example: https://northwind.example
                          type:
                            - string
                            - 'null'
                        primary_color:
                          description: The brand color as a hex value, if one was set.
                          example: '#1F6FEB'
                          type:
                            - string
                            - 'null'
                        status:
                          type: string
                          enum:
                            - active
                            - inactive
                          description: >-
                            `active` brands can run campaigns. `inactive` brands
                            are archived.
                          example: active
                        created_at:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                          description: When the brand was created.
                          example: '2026-09-02T10:15:00.000Z'
                        updated_at:
                          anyOf:
                            - type: string
                              format: date-time
                              pattern: >-
                                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                            - type: 'null'
                          description: >-
                            When the brand was last changed. Null if it never
                            changed.
                          example: '2026-09-20T08:40:00.000Z'
                      required:
                        - id
                        - name
                        - description
                        - website_url
                        - primary_color
                        - status
                        - created_at
                        - updated_at
                      additionalProperties: false
                      description: A brand you can read.
                  next_cursor:
                    description: >-
                      Send this as `cursor` to get the next page. It is null on
                      the last page.
                    type:
                      - string
                      - 'null'
                required:
                  - data
                  - next_cursor
                additionalProperties: false
              example:
                data:
                  - id: brd_3f9c0a1b2c3d4e5f60718293a4b5c6d7
                    name: Northwind Coffee
                    description: Specialty coffee roasted in small batches.
                    website_url: https://northwind.example
                    primary_color: '#1F6FEB'
                    status: active
                    created_at: '2026-09-02T10:15:00.000Z'
                    updated_at: '2026-09-20T08:40:00.000Z'
                next_cursor: null
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
              example:
                error:
                  code: invalid_request
                  message: >-
                    The cursor is not valid for this request. Start again
                    without a cursor, or repeat the previous request with the
                    same filters.
                  request_id: 6f1c2a9e-4b7d-4c1a-9e2f-3a8b5c7d9e10
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
              example:
                error:
                  code: unauthorized
                  message: >-
                    Provide a valid API key as `Authorization: Bearer
                    cb_live_...`.
                  request_id: 0b7e4d2c-9a1f-4e3b-8c6d-5f2a1b9c7e34
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
              example:
                error:
                  code: internal_error
                  message: An unexpected error occurred.
                  request_id: 5a4b3c2d-1e0f-4a9b-8c7d-6e5f4a3b2c19
      security:
        - Authorization: []
components:
  schemas:
    error.BAD_REQUEST:
      type: object
      title: Bad request error (400)
      description: The error envelope every failed request returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_request
              description: A stable, machine-readable error code.
            message:
              type: string
              description: What went wrong, in words a person can act on.
            request_id:
              type: string
              description: The id of this request. Quote it when you contact support.
          required:
            - code
            - message
            - request_id
          additionalProperties: false
      required:
        - error
      additionalProperties: false
    error.UNAUTHORIZED:
      type: object
      title: Unauthorized error (401)
      description: The error envelope every failed request returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - unauthorized
              description: A stable, machine-readable error code.
            message:
              type: string
              description: What went wrong, in words a person can act on.
            request_id:
              type: string
              description: The id of this request. Quote it when you contact support.
          required:
            - code
            - message
            - request_id
          additionalProperties: false
      required:
        - error
      additionalProperties: false
    error.INTERNAL_SERVER_ERROR:
      type: object
      title: Internal server error error (500)
      description: The error envelope every failed request returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - internal_error
              description: A stable, machine-readable error code.
            message:
              type: string
              description: What went wrong, in words a person can act on.
            request_id:
              type: string
              description: The id of this request. Quote it when you contact support.
          required:
            - code
            - message
            - request_id
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````

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