Skip to main content
GET
https://tickward.com/api/v1
/
projects
/
{project_id}
Retrieve a project
curl --request GET \
  --url https://tickward.com/api/v1/projects/{project_id} \
  --header 'Authorization: Bearer <token>'
{
  "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>.

Path Parameters

​
project_id
string
required

Response

Project.

​
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