Get project

GET /data/projects/{instance_id}

Retrieve a project by its ID and return it as a JSON object. Supports including relations. Requires project access.

Path parameters

  • instance_id string(uuid) Required

Query parameters

  • relations boolean

    Whether to include relations

Responses

  • 200 application/json

    Project retrieved successfully

    Hide response attributes Show response attributes object
    • id string(uuid)
    • name string
    • production_type string
    • production_style string
    • project_status_id string(uuid)
    • project_status_name string
    • created_at string(date-time)
    • updated_at string(date-time)
  • 400

    Invalid ID format or query error

GET /data/projects/{instance_id}
curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"
Response examples (200)
{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "Project Name",
  "production_type": "feature",
  "production_style": "2d3d",
  "project_status_id": "b24a6ea4-ce75-4665-a070-57453082c25",
  "project_status_name": "Open",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}