> ## 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. # Get a project > The project's configuration: brand, aliases, tracked competitors, market, engines and segments (only claimed segments count towards scores). ## OpenAPI ````yaml /api-reference/openapi.json get /projects/{projectId} 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/{projectId}: get: tags: - Projects summary: Get a project description: >- The project's configuration: brand, aliases, tracked competitors, market, engines and segments (only claimed segments count towards scores). operationId: getProjectsByProjectId parameters: - name: projectId in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: 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 brand: 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 domain: type: - string - 'null' required: - id - name - domain additionalProperties: false aliases: 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)$ alias: type: string source: type: string reviewed: type: boolean required: - id - alias - source - reviewed additionalProperties: false competitors: type: array items: type: object properties: brand_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 domain: type: - string - 'null' segment_id: type: - string - 'null' source: type: string required: - brand_id - name - domain - segment_id - source additionalProperties: false market: type: string engines: type: array items: type: object properties: engine: type: string enabled: type: boolean available_on_plan: type: boolean opt_in: type: boolean required: - engine - enabled - available_on_plan - opt_in additionalProperties: false segments: type: array items: type: object properties: id: type: string name: type: string claimed: type: boolean prompts: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - id - name - claimed - prompts additionalProperties: false required: - id - name - brand - aliases - competitors - market - engines - segments additionalProperties: false example: id: 00000000-0000-4000-8000-000000000001 name: Acme brand: id: 00000000-0000-4000-8000-000000000002 name: Acme domain: acme.example aliases: [] competitors: [] market: US engines: - engine: chatgpt enabled: true available_on_plan: true opt_in: false - engine: google-ai-overview enabled: true available_on_plan: true opt_in: false - engine: perplexity enabled: true available_on_plan: true opt_in: false segments: - id: ops name: ops claimed: false prompts: 1 - id: wms name: wms claimed: true prompts: 3 '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/{projectId}" \ -H "Authorization: Bearer $CITINO_API_KEY" - lang: python label: Python source: |- import os import requests res = requests.get( "https://api.citino.ai/v1/projects/{projectId}", 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/{projectId}", { 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 `. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.