Skip to main content
POST
https://tickward.com/api/v1
/
projects
curl --request POST \
  --url https://tickward.com/api/v1/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Launch Plan"
}
'
{
  "object": "project",
  "id": "project_123",
  "name": "Launch Plan",
  "color": "#111827",
  "created_at": "2026-06-07T12:00:00.000Z",
  "updated_at": "2026-06-07T12:00:00.000Z",
  "claimed_at": "2026-06-07T12:00:00.000Z",
  "timer_count": 3,
  "space_count": 2
}

Authorizations

​
Authorization
string
header
default:tw_your_api_key
required

Use a tickward API key from Settings. API keys start with tw_. Store keys as secrets and send them as Authorization: Bearer <key>.

Headers

​
Idempotency-Key
string

Optional for POST, PATCH, and DELETE requests. Generate a random UUID with an operation prefix, for example timer-create-${crypto.randomUUID()}. Reuse the same key with the same method, path, query, and JSON body to safely retry one logical write for up to 24 hours. Reusing it with a different request returns 409. The server stores only a hash of the key.

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9._:-]+$

Body

application/json
​
name
string
required
Required string length: 1 - 40
​
color
string

Use a hex color such as #2563eb. Empty string clears color where supported.

Pattern: ^$|^#[0-9a-fA-F]{6}$
​
expected_plan_hash
string

Optional plan hash returned by POST /projects/preview. When present, the create request fails if the current body no longer matches the preview.

Pattern: ^sha256:[a-f0-9]{64}$
​
spaces
object[]

Spaces to create with the project. Timers can be nested inside a space.

​
timers
object[]

Timers to create with the project. Use space_id only when referencing a space id supplied in spaces[].id.

Response

Created project with created spaces and timers.

​
object
string
required
Allowed value: "project"
​
id
string
required
​
name
string
required
Maximum string length: 40
​
color
string | null
required
Pattern: ^#[0-9a-fA-F]{6}$
​
created_at
string<date-time>
required

ISO 8601 datetime string. Prefer UTC with Z or an explicit offset.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Example:

"2026-10-10T09:30:00.000Z"

​
updated_at
string<date-time>
required

ISO 8601 datetime string. Prefer UTC with Z or an explicit offset.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Example:

"2026-10-10T09:30:00.000Z"

​
claimed_at
string<date-time> | null
required
Example:

"2026-10-10T09:30:00.000Z"

​
timer_count
integer
required
Required range: x >= 0
​
space_count
integer
required
Required range: x >= 0
​
spaces
object[]
required
​
timers
object[]
required