> ## 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.

# Get project

> One project's brand details. A key pinned to a project can read only that project; any other id returns 404.
Works with any scope.




## OpenAPI

````yaml /openapi.yaml get /projects/{project}
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/{project}:
    get:
      tags:
        - Project
      summary: Get project
      description: >
        One project's brand details. A key pinned to a project can read only
        that project; any other id returns 404.

        Works with any scope.
      parameters:
        - name: project
          in: path
          required: true
          description: A project ID from `GET /projects`.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Project details
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - properties:
                      data:
                        type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                          name:
                            type: string
                            example: Acme Inc.
                          logo:
                            type:
                              - string
                              - 'null'
                            description: Logo URL
                          status:
                            type: string
                            enum:
                              - ACTIVE
                              - ARCHIVED
                          brand_name:
                            type:
                              - string
                              - 'null'
                            example: Acme
                          brand_domain:
                            type:
                              - string
                              - 'null'
                            example: acme.com
                          brand_variants:
                            type: array
                            items:
                              type: string
                            description: Other names AI answers may use for the brand
                          about:
                            type:
                              - string
                              - 'null'
                            description: Brand brief
                          products:
                            type: array
                            items:
                              type: object
                            description: Named product briefs
                          audiences:
                            type: array
                            items:
                              type: object
                            description: Named audience briefs
                          location_code:
                            type:
                              - integer
                              - 'null'
                            description: Google location code used for Google AI answers
                          language_code:
                            type:
                              - string
                              - 'null'
                            example: en
                          is_configured:
                            type: boolean
                            description: >-
                              `true` once setup is finished and collection can
                              run
                          created_at:
                            type: string
                            format: date-time
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Not found, or not readable by this key
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.