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

# List brand terms

> Pages the project's brand terms: the brand and product names DevTune watches for in AI answers to count mentions. Only active terms are listed unless includeInactive is true; a retired term is one deleted while assigned to a brand, kept so earlier mentions stay attributed. Ordered by id. Pass nextCursor back as cursor with includeInactive unchanged. This is a live listing, not a snapshot. Requires the setup.read scope.



## OpenAPI

````yaml /openapi.json get /projects/{projectId}/setup/keywords
openapi: 3.1.0
info:
  title: DevTune API
  version: 2.0.0
  description: >-
    API for programmatic access to your AI visibility data, webhook
    subscriptions, and automation workflows. Use this API to integrate DevTune
    data into CI/CD pipelines, BI tools, AI agents, and operational systems.
servers:
  - url: https://devtune.ai/api/v2
    description: Production
security:
  - bearerAuth: []
paths:
  /projects/{projectId}/setup/keywords:
    get:
      summary: List brand terms
      description: >-
        Pages the project's brand terms: the brand and product names DevTune
        watches for in AI answers to count mentions. Only active terms are
        listed unless includeInactive is true; a retired term is one deleted
        while assigned to a brand, kept so earlier mentions stay attributed.
        Ordered by id. Pass nextCursor back as cursor with includeInactive
        unchanged. This is a live listing, not a snapshot. Requires the
        setup.read scope.
      operationId: listBrandTerms
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: includeInactive
          in: query
          schema:
            type: boolean
            default: false
        - name: pageSize
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          description: >-
            The same setting as pageSize. Send either; both with different
            values returns 400.
        - name: cursor
          in: query
          schema:
            type: string
            minLength: 1
            maxLength: 512
      responses:
        '200':
          description: One page
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SetupBrandTermsPage'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '429':
          $ref: '#/components/responses/RateLimitExceededError'
components:
  schemas:
    SetupBrandTermsPage:
      type: object
      additionalProperties: false
      required:
        - items
        - includeInactive
        - pageSize
        - hasMore
        - nextCursor
        - pagination
      properties:
        pagination:
          $ref: '#/components/schemas/ListPagination'
        items:
          type: array
          maxItems: 100
          items:
            $ref: '#/components/schemas/SetupBrandTerm'
        includeInactive:
          type: boolean
        pageSize:
          type: integer
          minimum: 1
          maximum: 100
        hasMore:
          type: boolean
        nextCursor:
          type:
            - string
            - 'null'
    Meta:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
        projectId:
          type: string
          format: uuid
    ListPagination:
      type: object
      properties:
        hasMore:
          type: boolean
          description: More rows follow this page.
        nextCursor:
          type:
            - string
            - 'null'
          description: Pass as cursor to read the next page; null on the last page.
      required:
        - hasMore
        - nextCursor
    SetupBrandTerm:
      type: object
      additionalProperties: false
      required:
        - id
        - term
        - brandId
        - isActive
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          format: uuid
        term:
          type: string
        brandId:
          type:
            - string
            - 'null'
        isActive:
          type: boolean
          description: false for a retired term.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        reason:
          type: string
          description: >-
            Why the request was refused, for an error with more than one cause,
            such as a refused content-draft start.
        details:
          type: object
          additionalProperties: true
          description: >-
            Machine-readable facts about the refusal, such as shortfall_credits
            when an Agent Picks start is refused for insufficient_credits.
        status:
          type: integer
      required:
        - error
        - message
        - status
  responses:
    BadRequestError:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ForbiddenError:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimitExceededError:
      description: Rate limit exceeded
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  headers:
    X-RateLimit-Limit:
      description: Maximum requests per window
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests remaining in current window
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix timestamp when the window resets
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key with dtk_live_ prefix. Obtain it from API Keys in the account
        sidebar. New keys start with all supported scopes selected for the
        chosen project, and you can narrow them to specific read/write scopes as
        needed.

````

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