projects

Read Project

get/api/v1/projects/{project_id}

Request

Base URL: https://api.peil.app (the document declares no server; this is the origin it was published from)
URL: https://api.peil.app/api/v1/projects/{project_id}
Auth: OAuth 2 (password, token URL /api/v1/auth/jwt/login)

project_idinteger required

Successful Response

namestring required

descriptionstring nullable

activeboolean

billable_defaultboolean

client_idinteger nullable

start_datestring date nullable

end_datestring date nullable

budgetnumber nullable

status'active' | 'completed' | 'archived' | 'on_hold'

project_type'folder' | 'hourly' | 'fixed' | 'retainer'

retainer_monthlynumber nullable

retainer_hours_per_monthinteger nullable

retainer_interval'monthly' | 'quarterly' | 'annual' nullable

idinteger required

user_idinteger required

created_atstring date-time required

updated_atstring date-time required

client_namestring nullable

No recorded changes to this operation across all 1 revision of this API.