Skip to main content
GET
Get project by ID

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

project_id
integer
required

Response

200 - application/json

Project details

id
integer

Unique project identifier

name
string

Project name

brief
string

Project brief/description

client_id
integer

Associated client ID

health
enum<integer>

Project health indicator: 1 (on track), 2 (at risk), 3 (delayed), 4 (critical)

Available options:
1,
2,
3,
4
status
enum<string>

Project status

Available options:
active,
finished,
suspended
start
string<date-time>

Project start date

end
string<date-time>

Project end date

estimated_time
number

Estimated hours for the project

elapsed_time
number

Hours already logged

profitability_now
number

Current profitability percentage

estimated_profitability
number

Estimated profitability percentage

archived
boolean

Whether the project is archived

billable
boolean

Whether the project is billable

income_type
enum<string>

Project billing type

Available options:
fee,
one_time,
hourly_rate,
contract
pm_id
integer

Project Manager user ID

created_by
integer

User ID who created the project

company_id
integer

Company ID

template_id
integer

Project template ID used

brand_id
integer

Associated brand ID

product_id
integer

Associated product ID

total_estimated
number

Total estimated budget

created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp

labels
integer[]

IDs of labels assigned to this project. Resolve names and styling via Get Categories and Labels with model=project (GET /categories/labels-model?model=project), which returns label objects including the same id values.

client
object

Associated client object

pm
object

Project Manager details

estimated_by_position
boolean

Whether time estimation is split per position

estimation_by_categories

Whether time estimation is split per category

estimated_by_hourly_rates

Whether income is calculated from hourly rates using a ratecard

user_positions_header_id
integer | null

ID of the ratecard assigned to this project

fee_id
integer | null

Associated fee ID

contract_id
integer | null

Associated contract ID

usersPositionsProject
object[]

Positions assigned to the project with their estimated and logged hours. Only present when fetching a single project (GET /projects/{project_id}).

categoriesProject
object[]

Categories assigned to the project with their estimated and logged hours. Only present when fetching a single project.

ratecard
object | null

Ratecard assigned to this project. Only present when fetching a single project.