Objects

Get a project

Retrieves a single project by its ID (prj_ prefix).

get/projects/{id}

Request

  • Base URL: https://api.heffl.com/api/v2
  • URL: https://api.heffl.com/api/v2/projects/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Project ID

Response

OK

idstring nullable required

Project ID (prj_ prefix)

numberstring required

Auto-generated project number

titlestring required

Project title

status'ACTIVE' | 'COMPLETED' | 'CANCELLED' nullable

Project status

type'flat_rate' | 'retainer' nullable

Project type

startDatestring date-time nullable

Project start date

endDatestring date-time nullable

Project end date

pipelineIdstring nullable

Project pipeline ID (ppl_ prefix)

pipelineNamestring nullable

Pipeline name

stageIdstring nullable

Project pipeline stage ID (pps_ prefix)

stageNamestring nullable

Stage name

projectLeadIdstring nullable

Project lead user ID (usr_ prefix)

projectLeadNamestring nullable

Project lead name

clientIdstring nullable

Client ID (clt_ prefix)

clientNamestring nullable

Client name

descriptionstring nullable

Project description

budgetedHoursnumber nullable

Budgeted hours

createdAtstring date-time nullable

When the project was created

updatedAtstring date-time nullable

When the project was last updated

Changes

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