v1

latestOpenAPI 3.0.02026-08-068926279.2 KB

Projects

Get a specific project

Returns detailed information about a specific project

get/projects/{id}

Path parameters

idinteger required

Project ID

Response

Successful response

idinteger

team_idinteger

client_idinteger nullable

namestring

type'hourly' | 'fixed' | 'non-billable'

startstring nullable

endstring nullable

start_datestring date nullable

end_datestring date nullable

budgetnumber nullable

budget_usednumber

budget_remainingnumber

budget_reset'weekly' | 'monthly' | 'quarterly' | 'yearly' nullable

track_unbilled_hours_expected_revenueboolean

track_unbilled_fixed_expected_revenueboolean

total_hours_recordednumber

hoursnumber

hours_budgetstring

hours_recordedstring

hours_budget_percentagenumber

collectednumber

costnumber

profitnumber

actual_ratenumber

Example response

{
  "id": 1,
  "team_id": 1,
  "client_id": 1,
  "name": "Website Redesign",
  "type": "hourly",
  "status": "active",
  "start": "01/2024",
  "end": "12/2024",
  "start_date": "2024-01-01",
  "end_date": "2024-12-31",
  "budget": 10000,
  "budget_used": 5000,
  "budget_remaining": 5000,
  "budget_reset": "monthly",
  "track_unbilled_hours_expected_revenue": true,
  "total_hours_recorded": 45.5,
  "hours": 45.5,
  "hours_budget": "100:00",
  "hours_recorded": "45:30",
  "hours_budget_percentage": 45.5,
  "collected": 5000,
  "cost": 3000,
  "profit": 2000,
  "actual_rate": 110,
  "client": {
    "id": 1,
    "name": "Acme Corporation"
  },
  "users": [
    {
      "id": 1,
      "name": "John Doe",
      "avatar": "https://example.com/avatar.jpg"
    }
  ]
}