---
title: "Get a project"
method: GET
path: "/api/v1/projects/{project}"
tags: ["projects"]
---

# Get a project

`GET /api/v1/projects/{project}`

## Request

- Base URL: `https://pineprompt.com`
- URL: `https://pineprompt.com/api/v1/projects/{project}`
- Auth: HTTP bearer

Returns a single project. The project must belong to the active organization.

## Path parameters

- `project` integer, required

## Query parameters

- `include` string

## Response `200`

OK

- Project: A project represents a single brand or site you monitor. Its `brand_id` names the own brand, the brand every core metric is computed for.
  - `id` integer: The unique ID of the project.
  - `organization_id` integer: The ID of the organization that owns the project.
  - `name` string: The display name of the project.
  - `brand_id` integer, nullable: The ID of the project's own brand, or null while none has been designated.
  - `organization` Organization: An organization is the top-level billing entity and tenant boundary in Pineprompt. Every project, member, and API key belongs to exactly one organization.
    - `id` integer: The unique ID of the organization.
    - `name` string: The display name of the organization.
    - `created_at` string, date-time: When the organization was created.
    - `updated_at` string, date-time: When the organization was last updated.
  - `created_at` string, date-time: When the project was created.
  - `updated_at` string, date-time: When the project was last updated.

## Other responses

- `401`: Unauthorized
- `403`: Missing ability
- `404`: Not found
- `422`: Validation failed

---

[API](https://skmtc.dev/pineprompt/apis/pineprompt-api.md) · [All operations](https://skmtc.dev/pineprompt/apis/pineprompt-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pineprompt/apis/pineprompt-api/revisions/05dbb5241a27?raw)