Skip to main content
POST
https://tickward.com/api/v1
/
projects
/
{project_id}
/
shares
Create or reuse a shared timer link
curl --request POST \
  --url https://tickward.com/api/v1/projects/{project_id}/shares \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "timer_id": "timer_123"
}
'
{
  "object": "share",
  "id": "share_123",
  "project_id": "project_123",
  "project_name": "Main",
  "timer_id": "timer_123",
  "timer_label": "Flight check-in",
  "shared_at": "2026-06-07T12:10:00.000Z",
  "url_path": "/share/share_123",
  "created_at": "2026-06-07T12:10:00.000Z",
  "updated_at": "2026-06-07T12:10:00.000Z"
}

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._:-]+$

Path Parameters

​
project_id
string
required

Body

application/json
​
timer_id
string
required
Minimum string length: 1

Response

Share link.

​
object
string
required
Allowed value: "share"
​
id
string
required
​
project_id
string
required
​
project_name
string
required

Human-readable project name for agent confirmations.

​
timer_id
string | null
required
​
timer_label
string | null
required

Current timer label when the share still points at a timer in this project.

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

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

​
url_path
string
required
Example:

"/share/abc123"

​
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"