Skip to main content
Requires an API key with full_access scope.

Body

string
required
Project name. 1 to 100 characters.
string
required
Project description.
string
required
Project status. One of: draft, not_started, planned, in_progress, completed, on_hold, weather_delayed, technical_issues, cancelled, aborted, other.
Your workspace may show custom display names for these statuses in the dashboard. The API always uses the predefined values listed above. Use other with other_status_reason for statuses that don’t map to a predefined value.
string
required
Start date in ISO 8601 format (e.g. 2026-04-15).
string
End date in ISO 8601 format. Must be after start_date.
string
Your own identifier for this project. Max 255 characters. Useful for mapping to records in your own system.
string
Required when status is other. 1 to 200 characters.

Response

string
required
The unique identifier of the newly created project.

Errors

400 Bad Request - Validation failed.
Other validation messages include:
  • name must be between 1 and 100 characters
  • start_date is required
  • start_date must be a valid ISO date string
  • end_date must be after start_date
  • description is required
  • status must be one of: draft, not_started, in_progress, ...
  • other_status_reason is required when status is "other"
  • external_id must not exceed 255 characters
404 Not Found - Workspace not found.
429 Too Many Requests - Project limit reached for your workspace plan.