Retrieve Project

Auth required

GET/v1/projects/{project_id}/

Parameters

project_idrequiredstring · uuid

Credentials

X-APPLOYE-API-KEY

Stored in this browser tab only. Try It always sends your key; code samples show a YOUR_API_KEY placeholder until you reveal the key with the eye toggle.

curl --request GET \
  --url "https://api.apploye.com/v1/projects/__PROJECT_ID__/" \
  --header "accept: application/json" \
  --header "X-APPLOYE-API-KEY: YOUR_API_KEY"

Response

Project detail with client, budget, and created/updated-by

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "color": "string",
  "description": "string",
  "start_date": "2026-08-11",
  "deadline": "2026-08-11",
  "code": "string",
  "default": true,
  "status": "string",
  "is_active": true,
  "updated_at": "2026-08-11T02:31:37.681Z",
  "created_at": "2026-08-11T02:31:37.681Z",
  "client": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "color": "string",
    "email": "string"
  },
  "budget": {
    "budget_type": "string",
    "budget_amount": 0,
    "budget_hours": 0,
    "budget_hourly_based_on": "string"
  },
  "created_by": {
    "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "image": "string",
    "timezone": "string",
    "color": "string"
  },
  "updated_by": {
    "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "image": "string",
    "timezone": "string",
    "color": "string"
  }
}

Retrieve Project

Parameters#

Parameters