Skip to Content
DevelopersAPI referenceProjects

Get project

GET
/v1/projects/{id}

Authorization

apiKey
headerAuthorizationBearer <token>

An API key (blk_…) from Settings → API keys.

Path Parameters

id*string

Response Body

application/json
  1. response
id*string
name*string
description*string|null
status*string
Value in"active""on_hold""completed""archived"
clientId*string|null
clientName*string|null
quoteId*string|null
quoteNumber*string|null
billing*string
Value in"fixed""hourly""non_billable"
currency*string
budgetAmount*|
Range-9007199254740991 <= value <= 9007199254740991
hourlyRate*|
Range-9007199254740991 <= value <= 9007199254740991
estimateMinutes*|
Range-9007199254740991 <= value <= 9007199254740991
estimateAmount*|
Range-9007199254740991 <= value <= 9007199254740991
trackedSeconds*integer
Range-9007199254740991 <= value <= 9007199254740991
startDate*|
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
dueDate*|
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
isOverdue*boolean
taskCounts*
createdAt*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
updatedAt*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
Example Request
curl -X GET 'https://your-billleaf-api/v1/projects/string'
Example Response200
{  "id": "string",  "name": "string",  "description": "string",  "status": "active",  "clientId": "string",  "clientName": "string",  "quoteId": "string",  "quoteNumber": "string",  "billing": "fixed",  "currency": "string",  "budgetAmount": -9007199254740991,  "hourlyRate": -9007199254740991,  "estimateMinutes": -9007199254740991,  "estimateAmount": -9007199254740991,  "trackedSeconds": -9007199254740991,  "startDate": "2019-08-24",  "dueDate": "2019-08-24",  "isOverdue": true,  "taskCounts": {    "todo": -9007199254740991,    "in_progress": -9007199254740991,    "done": -9007199254740991  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}