---
title: "Get project"
method: GET
path: "/api/v1/project"
tags: ["Project"]
---

# Get project

`GET /api/v1/project`

## Request

- Base URL: `https://app.gaffer.sh`
- URL: `https://app.gaffer.sh/api/v1/project`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Returns the project associated with the authenticated project token.

## Response `200`

Project details

- object
  - `project` Project
    - `id` string, required: Unique project identifier
    - `name` string, required: Project name
    - `description` string, nullable: Optional project description
    - `retentionDays` integer, required: Report retention period in days
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

## Other responses

- `401`: Missing or invalid API key

---

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