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

# List your projects

> Every project the key can read, oldest first. A key limited to some projects lists only those.



## OpenAPI

````yaml /api-reference/openapi.json get /projects
openapi: 3.1.0
info:
  title: Citino API
  version: v1
  description: >-
    Read how AI engines answer your market's questions, and keep your prompts,
    competitors, segments and engines in step from code. Every number carries
    its band and sample size.
servers:
  - url: https://api.citino.ai/v1
security:
  - bearerAuth: []
tags:
  - name: Brand and competitors
  - name: Definitions
  - name: Engines
  - name: Projects
  - name: Alerts
  - name: Attribution
  - name: Claims
  - name: Crawlability
  - name: Crawler activity
  - name: Metrics
  - name: Experiments
  - name: Prompts
  - name: Objections
  - name: Monthly reports
  - name: Reports
  - name: Runs
  - name: Searches
  - name: Sources
  - name: Work items
  - name: Settings
paths:
  /projects:
    get:
      tags:
        - Projects
      summary: List your projects
      description: >-
        Every project the key can read, oldest first. A key limited to some
        projects lists only those.
      operationId: getProjects
      parameters:
        - name: cursor
          in: query
          required: false
          description: The previous page's next_cursor.
          schema:
            description: The previous page's next_cursor.
            type: string
            minLength: 1
            maxLength: 512
        - name: limit
          in: query
          required: false
          description: Rows per page.
          schema:
            description: Rows per page.
            type: integer
            minimum: 1
            maximum: 100
        - name: format
          in: query
          required: false
          description: csv returns the page as a CSV file.
          schema:
            description: csv returns the page as a CSV file.
            type: string
            enum:
              - json
              - csv
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        name:
                          type: string
                        status:
                          type: string
                        category_id:
                          type: string
                          description: The id of the project's prompt set.
                        engines:
                          type: array
                          items:
                            type: string
                        brand:
                          type: object
                          properties:
                            name:
                              type: string
                            domain:
                              type:
                                - string
                                - 'null'
                          required:
                            - name
                            - domain
                          additionalProperties: false
                        created_at:
                          type: string
                      required:
                        - id
                        - name
                        - status
                        - category_id
                        - engines
                        - brand
                        - created_at
                      additionalProperties: false
                  next_cursor:
                    type:
                      - string
                      - 'null'
                  has_more:
                    type: boolean
                required:
                  - items
                  - next_cursor
                  - has_more
                additionalProperties: false
              example:
                items:
                  - id: 00000000-0000-4000-8000-000000000001
                    name: Acme
                    status: active
                    category_id: f46-act/us
                    engines:
                      - chatgpt
                      - google-ai-overview
                      - perplexity
                    brand:
                      name: Acme
                      domain: acme.example
                    created_at: '2026-11-07T09:00:00.000Z'
                next_cursor: null
                has_more: false
            text/csv:
              schema:
                type: string
                description: >-
                  With format=csv: one row per item, figures flattened to value,
                  _band, _n and _low_sample columns. The next page is in the
                  Citino-Next-Cursor header.
        '400':
          description: The request is invalid; `error.field` names the parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'No live API key in an `Authorization: Bearer` header.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The key lacks the scope named in the message, or cannot write.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource in this key's projects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Over the key's or the workspace's rate limit; see `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Busy or timed out; retry after `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: bash
          label: curl
          source: |-
            curl "https://api.citino.ai/v1/projects" \
              -H "Authorization: Bearer $CITINO_API_KEY"
        - lang: python
          label: Python
          source: |-
            import os
            import requests

            res = requests.get(
                "https://api.citino.ai/v1/projects",
                headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"},
            )
            print(res.json())
        - lang: javascript
          label: JavaScript
          source: |-
            const res = await fetch("https://api.citino.ai/v1/projects", {
              headers: {
                Authorization: `Bearer ${process.env.CITINO_API_KEY}`,
              },
            });
            console.log(await res.json());
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >-
                validation, unauthorized, forbidden, not_found, conflict,
                plan_limit, rate_limited, busy, query_timeout
            message:
              type: string
            field:
              type: string
            detail:
              type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from Workspace settings → API keys, sent as `Authorization:
        Bearer <key>`.

````

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