Projects

Retrieve a project

Inspect a project's status and metadata.

get/projects/{project_id}v1

Authorization

Authentication is required. bearerAuth
Enter credentials in the playground. Reuse is optional and stays in memory.
Authorizationstringheaderrequired

Bearer authentication header. Use Bearer <token>, where <token> is your access token.

Path parameters

project_idstringrequired

Unique project identifier.

string

Response

The requested project.

application/json
object
idstringrequired
namestringrequired
descriptionstring
statusstringrequired
Allowed values: "draft""active""archived"
created_atstring · date-timerequired
metadataobject
Show child attributes
Additional properties string
string
Example response
Example response
{
  "id": "proj_aurora",
  "name": "Aurora",
  "description": "Customer-facing analytics",
  "status": "active",
  "created_at": "2026-01-15T10:30:00Z",
  "metadata": {
    "region": "eu-west"
  }
}
Source: openapi.yaml#/paths/~1projects~1{project_id}/get
Built with doctopus

What would you like to build?

Search guides, endpoints, and parameters.