Create a project

Authorization

BearerAuth

AuthorizationBearer <token>

Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.

In: header

Header Parameters

Idempotency-Key*string

Caller-generated UUID/ULID; replay returns the cached response within 24h.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Constraints enforced server-side: (1) budgetAmount and budgetHours are mutually exclusive — pass at most one. (2) FIXED projects must set fixedFeeAmount; HOURLY and NON_BILLABLE must NOT set it. (3) dueDate must be on or after startDate. Money fields accept a number or a decimal-string (up to 4 dp).

clientId*string

name*string

description?string

color?string

6-digit hex color (e.g. #2F855A). Server defaults to a curated palette color when omitted.

status?string

Defaults to ACTIVE. Note: archiving via DELETE soft-deletes (sets deletedAt) — distinct from this lifecycle status.

rateType?string

Defaults to HOURLY.

hourlyRate?string

Default hourly rate (number or decimal-string, > 0). Required for ALL rate types UNLESS the owning client has a defaultRate, which is then inherited. Not derived from rateType.

fixedFeeAmount?string

Total fixed fee (number or decimal-string, > 0). Required when rateType=FIXED; must be omitted otherwise.

budgetHours?string

Time budget in hours (number or decimal-string). Mutually exclusive with budgetAmount.

budgetAmount?string

Money budget (number or decimal-string). Mutually exclusive with budgetHours.

budgetWarnPct?integer

Warn at this percent of budget (1–200). Only meaningful when a budget is set.

startDate?string

ISO date YYYY-MM-DD.

dueDate?string

ISO date YYYY-MM-DD. Must be on or after startDate.

Response Body

`application/json`

curl -X POST "https://example.com/projects" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",    "name": "string"  }'

{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",    "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",    "name": "string",    "description": "string",    "color": "string",    "status": "ACTIVE",    "rateType": "HOURLY",    "hourlyRate": "string",    "fixedFeeAmount": "string",    "budgetHours": "string",    "budgetAmount": "string",    "startDate": "2019-08-24",    "dueDate": "2019-08-24",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "deletedAt": "2019-08-24T14:15:22Z"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}

{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}

Was this page helpful?

Authorization

Header Parameters

Request Body

Response Body

201application/json

401application/json

402application/json

403application/json

404application/json

409application/json

422application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`