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

# List projects

> The projects (brands) this key can read. A key pinned to a project returns only that one and `pinned` is `true`;
any other key returns every active project. Pass one of these ids as `project_id` on every `/visibility` call
when the key is not pinned. Works with any scope.




## OpenAPI

````yaml /openapi.yaml get /projects
openapi: 3.1.0
info:
  title: AeoNut API
  version: '1.0'
  description: >
    Read your workspace's AI visibility data for every project (brand) it
    tracks. Every response is wrapped in

    `{code, messages, data}`. Rates are fractions between 0 and 1 unless a field
    says otherwise.
servers:
  - url: https://services.aeonut.com/core/api/external/v1
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Me
  - name: Project
  - name: Workspace
  - name: AI visibility
paths:
  /projects:
    get:
      tags:
        - Project
      summary: List projects
      description: >
        The projects (brands) this key can read. A key pinned to a project
        returns only that one and `pinned` is `true`;

        any other key returns every active project. Pass one of these ids as
        `project_id` on every `/visibility` call

        when the key is not pinned. Works with any scope.
      responses:
        '200':
          description: Projects
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - properties:
                      data:
                        type: object
                        properties:
                          pinned:
                            type: boolean
                            description: '`true` when the key is locked to one project'
                          projects:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  format: uuid
                                name:
                                  type: string
                                  example: Acme Inc.
                                brand_name:
                                  type:
                                    - string
                                    - 'null'
                                  example: Acme
                                brand_domain:
                                  type:
                                    - string
                                    - 'null'
                                  example: acme.com
                                status:
                                  type: string
                                  enum:
                                    - ACTIVE
                                    - ARCHIVED
                                created_at:
                                  type: string
                                  format: date-time
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Envelope:
      type: object
      properties:
        code:
          type: integer
          description: AeoNut status code
        messages:
          type: string
        data: {}
  responses:
    Unauthorized:
      description: Missing (`code` 4021), invalid, revoked or expired (`code` 4022) API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            code: 4022
            messages: Invalid, revoked or expired API key.
            data: null
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `Authorization: Bearer API Key Value`'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-KEY

````

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