API reference

Build on your time data: read and write projects, sessions, reports, clients and invoices, and receive signed webhooks.

API version 4.0.0

Introduction

The Temporal.ist API gives your scripts and tools the same data as the app: projects, sessions and timers, reports, clients, invoices and webhooks. It is a JSON API over HTTPS at:

https://temporal.ist/api/v2

The API is part of the Pro and Team plans. Everything below is generated from the API's own schema, which you can also download as OpenAPI.

Authentication

Create a personal API key in the app under Settings → Integrations. A key either reads, or reads and writes, and it works with your account in your current organisation. Its secret is shown once; store it like a password, and revoke the key in the same place when you no longer need it.

Send the key as a bearer token on every request:

Authorization: Bearer tk_live_…

A missing, revoked or mistyped key answers 401. A read-only key answers 403 for anything that changes data. Without a plan that includes the API, requests answer 402.

Quickstart

List your projects, then start a timer on one of them:

curl https://temporal.ist/api/v2/projects \
  -H "Authorization: Bearer $TEMPORALIST_KEY"

curl -X POST https://temporal.ist/api/v2/sessions/start \
  -H "Authorization: Bearer $TEMPORALIST_KEY" \
  -H "Content-Type: application/json" \
  -d '{"project_id": "<project id>"}'

Requests and responses

JSON in and out, with snake_case field names.
Times are ISO 8601 instants with their offset, such as 2026-10-11T09:30:00+02:00. Day boundaries in reports follow your account's timezone.
Lists return {"items": [...], "next_cursor": "..."}. Pass next_cursor back as ?cursor= for the next page; ?limit= takes up to 200 (default 50). The last page has next_cursor: null.
Retries are safe. Creating requests accept your own id (a UUID). Sending the same request again returns the record that already exists instead of creating a second one.
Records you cannot see answer 404, whether they do not exist or belong to someone else.

Errors

Every error has the same shape:

{
  "error": {
    "code": "validation_error",
    "message": "Some fields need attention.",
    "fields": { "end_at": "End must be after the start." }
  }
}

Status	Meaning
`400`	The request cannot be done as asked; `code` says why.
`401`	The key is missing, revoked or wrong.
`402`	Your plan does not include this.
`403`	The key or your role is not allowed to do this.
`404`	The record does not exist, or is not yours.
`409`	It conflicts with the current state, such as a timer that is already running.
`422`	A field is invalid; `fields` names it.
`429`	Too many requests; wait and try again.

Receiving webhooks

A webhook subscription sends a POST to your HTTPS address for each event you choose: project.created, session.created, session.closed, invoice.created and invoice.paid. Every delivery carries:

X-Temporalist-Event: session.closed
X-Temporalist-Delivery: <delivery id, the same on every retry>
X-Temporalist-Signature: t=<unix time>,v1=<hex HMAC-SHA256>

To check a delivery, compute an HMAC-SHA256 with your subscription's secret as the key over the timestamp, a dot and the raw request body, and compare it with v1:

import hashlib, hmac

def is_genuine(secret: str, header: str, body: bytes) -> bool:
    parts = dict(item.split("=", 1) for item in header.split(","))
    expected = hmac.new(secret.encode(), f"{parts['t']}.".encode() + body, hashlib.sha256).hexdigest()
    return hmac.compare_digest(expected, parts["v1"])

Answer with any 2xx status within 10 seconds. Failed deliveries are retried with growing delays, up to eight attempts, so the same event can arrive more than once: use X-Temporalist-Delivery to skip duplicates. Addresses must be public HTTPS hosts, and redirects are not followed.

Identity

Who the key belongs to: account, timezone, organisation role and plan features.

GET`/api/v2/me`

Get MeRead key

Bootstrap for web, desktop, CLI and extension. 401 when signed out.

Returns: 200 MeOut

Projects

Projects you own or that your team shares with you. Names are labels; use the id to refer to a project.

GET`/api/v2/projects`

List ProjectsRead key

Parameters of GET /api/v2/projects
Name	In	Type	Description
`cursor`	query	`string \| null`
`limit`	query	`integer`	Default: 50.
`status`	query	`"active" \| "archived" \| "all"`	Default: "active".
`q`	query	`string \| null`	Case-insensitive substring of project or client name.
`client_id`	query	`string (uuid) \| null`
`trackable`	query	`boolean`	Only projects the caller may track on (own or team-assigned, active). Default: false.
`include_hidden`	query	`boolean`	Default: true.
`include_stats`	query	`boolean`	Default: false.
`sort`	query	`"name" \| "recent"`	`recent` = the caller's latest activity first. Default: "name".

Returns: 200 Page_ProjectOut_

POST`/api/v2/projects`

Create ProjectRead and write key

Body: ProjectCreate
Returns: 200 ProjectOut

GET`/api/v2/projects/{project_id}`

Get ProjectRead key

Parameters of GET /api/v2/projects/{project_id}
Name	In	Type	Description
`project_id`required	path	`string (uuid)`

Returns: 200 ProjectOut

PATCH`/api/v2/projects/{project_id}`

Update ProjectRead and write key

Parameters of PATCH /api/v2/projects/{project_id}
Name	In	Type	Description
`project_id`required	path	`string (uuid)`

Body: ProjectUpdate
Returns: 200 ProjectOut

POST`/api/v2/projects/{project_id}/archive`

Archive ProjectRead and write key

Parameters of POST /api/v2/projects/{project_id}/archive
Name	In	Type	Description
`project_id`required	path	`string (uuid)`

Returns: 200 ProjectOut

POST`/api/v2/projects/{project_id}/unarchive`

Unarchive ProjectRead and write key

Parameters of POST /api/v2/projects/{project_id}/unarchive
Name	In	Type	Description
`project_id`required	path	`string (uuid)`

Returns: 200 ProjectOut

Sessions and timers

Your own tracked time. Durations are seconds of worked time with pauses taken out; instants carry their UTC offset.

GET`/api/v2/sessions`

List SessionsRead key

Parameters of GET /api/v2/sessions
Name	In	Type	Description
`cursor`	query	`string \| null`
`limit`	query	`integer`	Default: 50.
`from_date`	query	`string (date) \| null`	Default depends on the endpoint.
`to_date`	query	`string (date) \| null`
`project_id`	query	`string (uuid)[]`
`client_id`	query	`string (uuid)[]`
`team_id`	query	`string (uuid)[]`	Projects assigned to these teams.
`user_id`	query	`string (uuid)[]`	Authors; organisation-wide views only.
`tag_id`	query	`string (uuid)[]`	Any of these on the session, project or client.
`billing`	query	`"any" \| "billed" \| "unbilled"`	Default: "any".
`scope`	query	`"me" \| "org"`	Default: "me".
`invoice_id`	query	`string (uuid) \| null`	Sessions claimed by this invoice.
`state`	query	`"any" \| "active" \| "closed" \| "deleted"`	Default: "any".
`origin`	query	`"web" \| "desktop_file" \| "desktop_manual" \| "browser_url" \| "browser_manual" \| "cli_manual" \| "cli_watch" \| "api" \| "mcp" \| "mobile" \| "unknown"[]`
`q`	query	`string \| null`	Case-insensitive search in descriptions.
`match`	query	`"overlap" \| "start"`	`overlap`: sessions overlapping the range; `start`: starting in it. Default: "overlap".
`changed_since`	query	`string (date-time) \| null`	Delta sync: the caller's own sessions changed after this instant, soft-deleted ones included (`deleted_at` set), oldest change first; the date range is ignored. Use `as_of` as the next value.

Returns: 200 SessionPage

POST`/api/v2/sessions`

Add EntryRead and write key

Body: EntryCreate
Returns: 200 EntryCreateOut

POST`/api/v2/sessions/start`

Start TimerRead and write key

Body: TimerStart
Returns: 200 TimerStartOut

GET`/api/v2/sessions/active`

Get ActiveRead key

Returns: 200 TimerSnapshot

GET`/api/v2/sessions/{session_id}`

Get SessionRead key

Parameters of GET /api/v2/sessions/{session_id}
Name	In	Type	Description
`session_id`required	path	`string (uuid)`

Returns: 200 SessionDetailOut

PATCH`/api/v2/sessions/{session_id}`

Update SessionRead and write key

Parameters of PATCH /api/v2/sessions/{session_id}
Name	In	Type	Description
`session_id`required	path	`string (uuid)`

Body: SessionUpdate
Returns: 200 SessionOut

DELETE`/api/v2/sessions/{session_id}`

Delete SessionRead and write key

Parameters of DELETE /api/v2/sessions/{session_id}
Name	In	Type	Description
`session_id`required	path	`string (uuid)`

Returns: 204 Successful Response

POST`/api/v2/sessions/{session_id}/stop`

Stop SessionRead and write key

Parameters of POST /api/v2/sessions/{session_id}/stop
Name	In	Type	Description
`session_id`required	path	`string (uuid)`

Body: SessionStop
Returns: 200 SessionOut

POST`/api/v2/sessions/{session_id}/pause`

Pause SessionRead and write key

Parameters of POST /api/v2/sessions/{session_id}/pause
Name	In	Type	Description
`session_id`required	path	`string (uuid)`

Body: PauseToggle
Returns: 200 PauseStateOut

POST`/api/v2/sessions/{session_id}/resume`

Resume SessionRead and write key

Parameters of POST /api/v2/sessions/{session_id}/resume
Name	In	Type	Description
`session_id`required	path	`string (uuid)`

Body: PauseToggle
Returns: 200 PauseStateOut

Reports

Totals per project and day in your account timezone, calculated exactly as the dashboard does.

GET`/api/v2/reports/summary`

Report SummaryRead key

Parameters of GET /api/v2/reports/summary
Name	In	Type	Description
`from_date`	query	`string (date) \| null`	Default depends on the endpoint.
`to_date`	query	`string (date) \| null`
`project_id`	query	`string (uuid)[]`
`client_id`	query	`string (uuid)[]`
`team_id`	query	`string (uuid)[]`	Projects assigned to these teams.
`user_id`	query	`string (uuid)[]`	Authors; organisation-wide views only.
`tag_id`	query	`string (uuid)[]`	Any of these on the session, project or client.
`billing`	query	`"any" \| "billed" \| "unbilled"`	Default: "any".
`scope`	query	`"me" \| "org"`	Default: "me".
`mode`	query	`"sessions" \| "day_span" \| null`	Default: the caller's full-day-span setting.
`compare`	query	`"none" \| "previous"`	`previous`: the equally long range right before (calendar unit when aligned). Default: "none".
`bucket`	query	`"day" \| "week" \| "month" \| null`	Default: day up to 31 days, week up to 26 weeks, else month.

Returns: 200 ReportSummaryOut

GET`/api/v2/reports/time`

Time ReportRead key

Parameters of GET /api/v2/reports/time
Name	In	Type
`period`	query	`"today" \| "yesterday" \| "this_week" \| "last_week" \| "this_month" \| "last_month" \| null`
`from_date`	query	`string (date) \| null`
`to_date`	query	`string (date) \| null`
`project_id`	query	`string (uuid) \| null`
`group_by`	query	`"project" \| "day" \| "task"[]`

Returns: 200 TimeReportOut

Clients

Billing clients of your organisation. Needs a plan with invoicing and the owner or admin role.

GET`/api/v2/clients`

List ClientsRead key

Parameters of GET /api/v2/clients
Name	In	Type	Description
`cursor`	query	`string \| null`
`limit`	query	`integer`	Default: 50.
`q`	query	`string \| null`	Case-insensitive substring of name or company.
`status`	query	`"active" \| "archived" \| "all"`	Default: "active".

Returns: 200 Page_ClientOut_

POST`/api/v2/clients`

Create ClientRead and write key

Body: ClientCreate
Returns: 200 ClientOut

GET`/api/v2/clients/{client_id}`

Get ClientRead key

Parameters of GET /api/v2/clients/{client_id}
Name	In	Type	Description
`client_id`required	path	`string (uuid)`

Returns: 200 ClientOut

PATCH`/api/v2/clients/{client_id}`

Update ClientRead and write key

Parameters of PATCH /api/v2/clients/{client_id}
Name	In	Type	Description
`client_id`required	path	`string (uuid)`

Body: ClientUpdate
Returns: 200 ClientOut

Invoices

Invoices built from tracked work. Marking an invoice sent records it; it does not email anyone.

GET`/api/v2/invoices`

List InvoicesRead key

Parameters of GET /api/v2/invoices
Name	In	Type	Description
`cursor`	query	`string \| null`
`limit`	query	`integer`	Default: 50.
`status`	query	`"draft" \| "sent" \| "overdue" \| "paid" \| "cancelled"[]`
`client_id`	query	`string (uuid) \| null`
`q`	query	`string \| null`	Number or client name, case-insensitive.

Returns: 200 InvoicePage

POST`/api/v2/invoices`

Create InvoiceRead and write key

Body: InvoiceCreate
Returns: 200 InvoiceDetailOut

GET`/api/v2/invoices/{invoice_id}`

Get InvoiceRead key

Parameters of GET /api/v2/invoices/{invoice_id}
Name	In	Type	Description
`invoice_id`required	path	`string (uuid)`

Returns: 200 InvoiceDetailOut

POST`/api/v2/invoices/{invoice_id}/mark-sent`

Mark SentRead and write key

Parameters of POST /api/v2/invoices/{invoice_id}/mark-sent
Name	In	Type	Description
`invoice_id`required	path	`string (uuid)`

Body: MarkSent
Returns: 200 InvoiceDetailOut

POST`/api/v2/invoices/{invoice_id}/mark-paid`

Mark PaidRead and write key

Parameters of POST /api/v2/invoices/{invoice_id}/mark-paid
Name	In	Type	Description
`invoice_id`required	path	`string (uuid)`

Body: MarkPaid
Returns: 200 InvoiceDetailOut

Webhooks

Subscriptions that POST signed events to your HTTPS endpoint. Delivery is at least once; deduplicate on the delivery id.

GET`/api/v2/webhook-subscriptions`

List Webhook SubscriptionsRead key

Parameters of GET /api/v2/webhook-subscriptions
Name	In	Type	Description
`cursor`	query	`string \| null`
`limit`	query	`integer`	Default: 50.
`api_key_id`	query	`string (uuid) \| null`	Cookie sessions: one key's only.

Returns: 200 Page_WebhookSubscriptionOut_

POST`/api/v2/webhook-subscriptions`

Create Webhook SubscriptionRead and write key

422 `unsafe_target` for non-public targets; 403 for `invoice.*` without billing role.

Body: WebhookSubscriptionCreate
Returns: 200 WebhookSubscriptionCreatedOut

GET`/api/v2/webhook-subscriptions/{subscription_id}`

Get Webhook SubscriptionRead key

Parameters of GET /api/v2/webhook-subscriptions/{subscription_id}
Name	In	Type	Description
`subscription_id`required	path	`string (uuid)`

Returns: 200 WebhookSubscriptionOut

PATCH`/api/v2/webhook-subscriptions/{subscription_id}`

Update Webhook SubscriptionRead and write key

Parameters of PATCH /api/v2/webhook-subscriptions/{subscription_id}
Name	In	Type	Description
`subscription_id`required	path	`string (uuid)`

Body: WebhookSubscriptionUpdate
Returns: 200 WebhookSubscriptionOut

DELETE`/api/v2/webhook-subscriptions/{subscription_id}`

Delete Webhook SubscriptionRead and write key

Parameters of DELETE /api/v2/webhook-subscriptions/{subscription_id}
Name	In	Type	Description
`subscription_id`required	path	`string (uuid)`

Returns: 204 Successful Response

GET`/api/v2/webhook-subscriptions/{subscription_id}/deliveries`

List Webhook DeliveriesRead key

Parameters of GET /api/v2/webhook-subscriptions/{subscription_id}/deliveries
Name	In	Type	Description
`subscription_id`required	path	`string (uuid)`
`cursor`	query	`string \| null`
`limit`	query	`integer`	Default: 50.
`status`	query	`"pending" \| "delivered" \| "dead" \| "cancelled" \| null`

Returns: 200 Page_WebhookDeliveryOut_

POST`/api/v2/webhook-subscriptions/{subscription_id}/deliveries/{delivery_id}/retry`

Retry Webhook DeliveryRead and write key

409 unless the delivery is dead or cancelled.

Parameters of POST /api/v2/webhook-subscriptions/{subscription_id}/deliveries/{delivery_id}/retry
Name	In	Type	Description
`subscription_id`required	path	`string (uuid)`
`delivery_id`required	path	`string (uuid)`

Returns: 200 WebhookDeliveryOut

POST`/api/v2/webhook-subscriptions/{subscription_id}/rotate-secret`

Rotate Webhook SecretRead and write key

Parameters of POST /api/v2/webhook-subscriptions/{subscription_id}/rotate-secret
Name	In	Type	Description
`subscription_id`required	path	`string (uuid)`

Returns: 200 WebhookSecretOut

Schemas

ActiveSessionOut

Fields of ActiveSessionOut
Name	Type	Description
`id`required	`string (uuid)`
`user_id`required	`string (uuid)`
`organisation_id`required	`string (uuid)`
`project`required	`ProjectRef`
`start_at`required	`string (date-time)`
`end_at`required	`string (date-time) \| null`
`is_active`required	`boolean`
`is_paused`required	`boolean`
`origin`required	`"web" \| "desktop_file" \| "desktop_manual" \| "browser_url" \| "browser_manual" \| "cli_manual" \| "cli_watch" \| "api" \| "mcp" \| "mobile" \| "unknown"`
`is_manual`required	`boolean`
`description`required	`string`
`worked_seconds`required	`integer`	Pause-aware; a running session counts up to the response's `as_of`.
`tags`required	`TagRef[]`	Tags attached to the session itself.
`tasks`required	`TaskSummaryOut[]`
`files_changed`required	`integer \| null`	Distinct changed paths; null without file evidence.
`billing`required	`SessionBillingOut \| null`
`client_session_id`required	`string (uuid) \| null`	Legacy idempotency key of old clients.
`device_id`required	`string (uuid) \| null`
`continued_from_session_id`required	`string (uuid) \| null`	Set on the continuation of a live 24 h segment.
`deleted_at`required	`string (date-time) \| null`	Only set in change feeds (`changed_since`) and on deletion.
`version`required	`integer`	Increments on every change.
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`
`pauses`required	`PauseOut[]`
`last_activity_at`required	`string (date-time) \| null`

AddressIn

Fields of AddressIn
Name	Type	Description
`line1`	`string`	Default: "".
`line2`	`string`	Default: "".
`street`	`string`	Default: "".
`house_number`	`string`	Default: "".
`postal_code`	`string`	Default: "".
`city`	`string`	Default: "".
`region`	`string`	Default: "".
`country_code`	`string \| null`	ISO 3166-1 alpha-2.

AddressOut

Fields of AddressOut
Name	Type	Description
`line1`required	`string`
`line2`required	`string`
`street`required	`string`
`house_number`required	`string`
`postal_code`required	`string`
`city`required	`string`
`region`required	`string`
`country_code`required	`string \| null`
`formatted`required	`string`	One line as printed on invoices: `street no, zip city, CC`.

BillableSplitOut

ORG-10: a resolved rate, zero included, makes time billable (DEC-19).

Fields of BillableSplitOut
Name	Type	Description
`billable_seconds`required	`integer`
`non_billable_seconds`required	`integer`
`billed_seconds`required	`integer`	Claimed by an invoice.
`unbilled_seconds`required	`integer`
`by_currency`required	`CurrencyAmountOut[]`	Never summed across currencies.

BucketOut

Fields of BucketOut
Name	Type	Description
`start_date`required	`string (date)`
`end_date`required	`string (date)`
`label`required	`string`	E.g. `Mon 6`, `Week 41`, `October`.
`seconds`required	`integer`
`by_project`required	`ProjectBucketSecondsOut[]`

ClientCreate

Fields of ClientCreate
Name	Type	Description
`id`	`string (uuid) \| null`	Client-generated id; a replay returns the existing client.
`name`required	`string`
`email`required	`string`	Where invoices are sent (DEC-16).
`company`	`string`	Default: "".
`phone`	`string`	Default: "".
`address`	`AddressIn \| null`
`address_line`	`string \| null`	Free-text address, geocoded into fields; not with `address`.
`tax_id`	`string \| null`
`hourly_rate`	`number \| string \| null`
`currency`	`string \| null`	Required with `hourly_rate`.
`tags`	`string[]`

ClientOut

Fields of ClientOut
Name	Type	Description
`id`required	`string (uuid)`
`legacy_id`required	`integer \| null`
`organisation_id`required	`string (uuid)`
`name`required	`string`
`company`required	`string`
`email`required	`string \| null`	Billing email; migrated contacts may lack one (CLI-01).
`phone`required	`string`
`address`required	`AddressOut \| null`
`tax_id`required	`string \| null`
`hourly_rate`required	`string \| null`	Per hour, major units; null inherits the organisation default.
`currency`required	`string \| null`
`tags`required	`TagRef[]`
`status`required	`"active" \| "archived"`
`archived_at`required	`string (date-time) \| null`
`project_count`required	`integer`
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`

ClientRef

Fields of ClientRef
Name	Type	Description
`id`required	`string (uuid)`
`name`required	`string`
`company`required	`string`
`email`required	`string \| null`

ClientSecondsOut

Fields of ClientSecondsOut
Name	Type	Description
`client`required	`NamedRef \| null`	Null groups projects without a client.
`seconds`required	`integer`
`share`required	`number`

ClientUpdate

Only fields present change; null clears `address`, `tax_id`, `hourly_rate`, `currency`.

Fields of ClientUpdate
Name	Type	Description
`name`	`string \| null`
`email`	`string \| null`
`company`	`string \| null`
`phone`	`string \| null`
`address`	`AddressIn \| null`
`address_line`	`string \| null`
`tax_id`	`string \| null`
`hourly_rate`	`number \| string \| null`
`currency`	`string \| null`
`tags`	`string[] \| null`	Full replacement.

ComparisonOut

Fields of ComparisonOut
Name	Type	Description
`from_date`required	`string (date)`
`to_date`required	`string (date)`
`totals`required	`ReportTotalsOut`
`change_ratio`required	`number \| null`	(current - previous) ÷ previous worked time; null when previous is 0.

ConnectedClientOut

Fields of ConnectedClientOut
Name	Type	Description
`kind`required	`"web" \| "desktop" \| "cli" \| "browser" \| "mobile"`
`browser`required	`"chrome" \| "edge" \| "firefox" \| "safari" \| null`
`device_id`required	`string (uuid) \| null`
`client_version`required	`string \| null`
`connected_at`required	`string (date-time)`

CredentialOut

Fields of CredentialOut
Name	Type	Description
`via`required	`"cookie" \| "oauth" \| "api_key"`
`scopes`required	`string[]`
`session_id`required	`string (uuid) \| null`
`connection_id`required	`string (uuid) \| null`
`api_key_id`required	`string (uuid) \| null`

CurrencyAmountOut

Fields of CurrencyAmountOut
Name	Type	Description
`currency`required	`string`
`billed_minor`required	`integer`	From the invoice lines billing the range's sessions; cancelled ones excluded.
`unbilled_minor`required	`integer`	Estimate at current rates (not an invoice).
`total_minor`required	`integer`

CurrencyTotalsOut

Fields of CurrencyTotalsOut
Name	Type	Description
`currency`required	`string`
`invoice_count`required	`integer`	Every invoice in the selection, cancelled included.
`total_minor`required	`integer`	Drafts, outstanding and paid; cancelled ones add nothing.
`draft_minor`required	`integer`
`outstanding_minor`required	`integer`	Sent and overdue.
`paid_minor`required	`integer`

DaySecondsOut

Fields of DaySecondsOut
Name	Type	Description
`date`required	`string (date)`
`seconds`required	`integer`

EntitlementsOut

What the user may do right now. The one source for plan gates in every client.

Fields of EntitlementsOut
Name	Type	Description
`plan`required	`"solo" \| "pro" \| "team"`
`source`required	`"subscription" \| "grant" \| "inherited" \| "none"`
`features`required	`"invoicing" \| "calendar" \| "api" \| "mcp" \| "export" \| "team" \| "full_history"[]`
`seats`required	`integer`	Team seats the user owns as an organisation owner; else 0.
`expires_at`required	`string (date-time) \| null`	End of the deciding source (grant expiry or paid-through date).
`history_floor`required	`string (date-time) \| null`	Earliest visible instant; null means full history.
`inherited_from_organisation_id`required	`string (uuid) \| null`	Set when Team access comes from the org owner.

EntryCreate

A completed time entry (TIM-04); manual entries span at most 24 h.

Fields of EntryCreate
Name	Type	Description
`id`	`string (uuid) \| null`	Client-generated id; a replay returns the existing entry.
`project_id`required	`string (uuid)`
`start_at`required	`string (date-time)`
`end_at`	`string (date-time) \| null`
`duration_seconds`	`integer \| null`	Alternative to `end_at`.
`description`	`string`	Default: "".
`tags`	`string[]`
`origin`	`"web" \| "desktop_file" \| "desktop_manual" \| "browser_url" \| "browser_manual" \| "cli_manual" \| "cli_watch" \| "api" \| "mcp" \| "mobile"`	Default: "web".
`is_manual`	`boolean`	False for automatic records uploaded after the fact. Default: true.
`device_id`	`string (uuid) \| null`
`client_session_id`	`string (uuid) \| null`	Legacy idempotency key (old clients).

EntryCreateOut

Fields of EntryCreateOut
Name	Type	Description
`session`required	`SessionOut`
`created`required	`boolean`	False on an idempotent replay.
`overlapping`required	`SessionOut[]`	The caller's sessions on the same project that overlap it.

IntervalOut

Fields of IntervalOut
Name	Type	Description
`start_at`required	`string (date-time)`
`end_at`required	`string (date-time)`

InvoiceCreate

Fields of InvoiceCreate
Name	Type	Description
`client_id`required	`string (uuid)`
`period_start`	`string (date) \| null`	With `period_end`; both absent: all unbilled work.
`period_end`	`string (date) \| null`
`project_ids`	`string (uuid)[]`
`session_ids`	`string (uuid)[]`
`scope`	`"me" \| "org"`	`org`: deliberately include members' work. Default: "me".
`mode`	`"sessions" \| "day_span" \| null`	Default: the creator's full-day-span setting.
`overlap_strategy`	`"add" \| "merge"`	Default: "add".
`rate_overrides`	`RateOverride[]`
`tax_bp`	`integer \| null`	Default: the organisation's remembered rate.
`notes`	`string`	Default: "".
`show_tasks`	`boolean`	Default: true.
`id`	`string (uuid) \| null`	Client-generated id; a replay returns the same draft.

InvoiceDeliveryOut

Fields of InvoiceDeliveryOut
Name	Type	Description
`id`required	`string (uuid)`
`recipient`required	`string`
`subject`required	`string`
`status`required	`"queued" \| "sent" \| "failed"`
`error`required	`string \| null`
`created_at`required	`string (date-time)`
`sent_at`required	`string (date-time) \| null`

InvoiceDetailOut

Fields of InvoiceDetailOut
Name	Type	Description
`id`required	`string (uuid)`
`legacy_id`required	`integer \| null`
`number`required	`string`
`status`required	`"draft" \| "sent" \| "overdue" \| "paid" \| "cancelled"`
`client`required	`ClientRef`
`organisation_id`required	`string (uuid)`
`created_by_user_id`required	`string (uuid) \| null`
`period_start`required	`string (date)`
`period_end`required	`string (date)`
`issue_date`required	`string (date) \| null`
`due_date`required	`string (date) \| null`
`paid_date`required	`string (date) \| null`
`cancelled_at`required	`string (date-time) \| null`
`timezone`required	`string`	Dates and public views use this zone, never the viewer's (INV-24).
`currency`required	`string`
`subtotal_minor`required	`integer`
`tax_bp`required	`integer`
`tax_minor`required	`integer`
`total_minor`required	`integer`
`notes`required	`string`
`show_tasks`required	`boolean`
`mode`required	`"sessions" \| "day_span"`
`overlap_strategy`required	`"add" \| "merge"`
`round_up_minutes`required	`integer`
`rounding`required	`"half_up" \| "legacy_half_even"`	Migrated invoices keep their old rounding.
`line_count`required	`integer`
`share_url`required	`string \| null`	Public link; null after revocation.
`last_delivery`required	`InvoiceDeliveryOut \| null`
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`
`lines`required	`InvoiceLineOut[]`	By project name, then creation.
`deliveries`required	`InvoiceDeliveryOut[]`	Newest first.

InvoiceLineOut

Fields of InvoiceLineOut
Name	Type	Description
`project`required	`ProjectRef \| null`
`description`required	`string`
`raw_seconds`required	`integer`	Worked seconds of the claimed sessions before overlap and rounding.
`billable_seconds`required	`integer`
`hours`required	`string`
`rate`required	`string \| null`
`rate_source`required	`"invoice" \| "project" \| "client" \| "org" \| "none" \| "manual"`
`amount_minor`required	`integer`
`task_breakdown`required	`TaskHoursOut[]`
`session_ids`required	`string (uuid)[]`
`id`required	`string (uuid)`
`position`required	`integer`
`kind`required	`"time" \| "custom"`

InvoiceOut

Fields of InvoiceOut
Name	Type	Description
`id`required	`string (uuid)`
`legacy_id`required	`integer \| null`
`number`required	`string`
`status`required	`"draft" \| "sent" \| "overdue" \| "paid" \| "cancelled"`
`client`required	`ClientRef`
`organisation_id`required	`string (uuid)`
`created_by_user_id`required	`string (uuid) \| null`
`period_start`required	`string (date)`
`period_end`required	`string (date)`
`issue_date`required	`string (date) \| null`
`due_date`required	`string (date) \| null`
`paid_date`required	`string (date) \| null`
`cancelled_at`required	`string (date-time) \| null`
`timezone`required	`string`	Dates and public views use this zone, never the viewer's (INV-24).
`currency`required	`string`
`subtotal_minor`required	`integer`
`tax_bp`required	`integer`
`tax_minor`required	`integer`
`total_minor`required	`integer`
`notes`required	`string`
`show_tasks`required	`boolean`
`mode`required	`"sessions" \| "day_span"`
`overlap_strategy`required	`"add" \| "merge"`
`round_up_minutes`required	`integer`
`rounding`required	`"half_up" \| "legacy_half_even"`	Migrated invoices keep their old rounding.
`line_count`required	`integer`
`share_url`required	`string \| null`	Public link; null after revocation.
`last_delivery`required	`InvoiceDeliveryOut \| null`
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`

InvoicePage

Fields of InvoicePage
Name	Type	Description
`items`required	`InvoiceOut[]`
`next_cursor`required	`string \| null`
`totals`required	`CurrencyTotalsOut[]`	Whole selection per currency, never converted (INV-01).

MarkPaid

Fields of MarkPaid
Name	Type	Description
`paid_date`	`string (date) \| null`	Default today in the invoice timezone.

MarkSent

Fields of MarkSent
Name	Type	Description
`issue_date`	`string (date) \| null`	Default today in the invoice timezone.
`due_date`	`string (date) \| null`	Default issue date + payment terms (30 days).

MemberRef

Fields of MemberRef
Name	Type	Description
`user_id`required	`string (uuid)`
`display_name`required	`string`

MemberSecondsOut

Fields of MemberSecondsOut
Name	Type	Description
`member`required	`MemberRef`
`seconds`required	`integer`
`tracked_days`required	`integer`
`session_count`required	`integer`
`share`required	`number`
`projects`required	`ProjectSecondsOut[]`

MeOrganisationOut

Fields of MeOrganisationOut
Name	Type	Description
`id`required	`string (uuid)`
`legacy_id`required	`integer \| null`
`name`required	`string`
`role`required	`"owner" \| "admin" \| "member"`
`status`required	`"active" \| "archived" \| "closed"`

MeOut

Bootstrap for every client: one request instead of profile + settings + plan + org.

Fields of MeOut
Name	Type	Description
`user`required	`UserOut`
`settings`required	`SettingsOut`
`organisation`required	`MeOrganisationOut`
`entitlements`required	`EntitlementsOut`
`onboarding`required	`OnboardingOut`
`credential`required	`CredentialOut`
`csrf_token`required	`string \| null`	Send as X-CSRF-Token on cookie-authenticated writes; null for bearer.

NamedRef

Compact reference to a named record; also the shape of resolution candidates.

Fields of NamedRef
Name	Type	Description
`id`required	`string (uuid)`
`name`required	`string`

OnboardingOut

Fields of OnboardingOut
Name	Type	Description
`needs_onboarding`required	`boolean`
`onboarding_seen_at`required	`string (date-time) \| null`
`tour_completed_at`required	`string (date-time) \| null`

Page_ClientOut_

Fields of Page_ClientOut_
Name	Type	Description
`items`required	`ClientOut[]`
`next_cursor`required	`string \| null`

Page_ProjectOut_

Fields of Page_ProjectOut_
Name	Type	Description
`items`required	`ProjectOut[]`
`next_cursor`required	`string \| null`

Page_WebhookDeliveryOut_

Fields of Page_WebhookDeliveryOut_
Name	Type	Description
`items`required	`WebhookDeliveryOut[]`
`next_cursor`required	`string \| null`

Page_WebhookSubscriptionOut_

Fields of Page_WebhookSubscriptionOut_
Name	Type	Description
`items`required	`WebhookSubscriptionOut[]`
`next_cursor`required	`string \| null`

PauseOut

Fields of PauseOut
Name	Type	Description
`id`required	`string (uuid)`
`legacy_id`required	`integer \| null`	Old integer id (old clients send it back).
`session_id`required	`string (uuid)`
`kind`required	`"manual" \| "sleep" \| "gap"`
`start_at`required	`string (date-time)`
`end_at`required	`string (date-time) \| null`
`seconds`required	`integer`	Length clipped to the session; an open pause counts up to `as_of`.

PauseStateOut

Fields of PauseStateOut
Name	Type	Description
`session`required	`SessionOut`
`paused`required	`boolean`
`changed`required	`boolean`	False when the session already was in the requested state.
`paused_since`required	`string (date-time) \| null`

PauseToggle

Fields of PauseToggle
Name	Type	Description
`at`	`string (date-time) \| null`	Default now; within [session start, now].

ProjectBillingOut

Billing fields. Present only for callers with billing authority (org owner/admin).

Fields of ProjectBillingOut
Name	Type	Description
`hourly_rate`required	`string \| null`	Project override; null inherits from client/organisation.
`currency`required	`string \| null`	Currency of the project rate; null when no project rate is set.
`resolved`required	`ResolvedRate`

ProjectBucketSecondsOut

Fields of ProjectBucketSecondsOut
Name	Type	Description
`project_id`required	`string (uuid)`
`seconds`required	`integer`

ProjectCreate

Fields of ProjectCreate
Name	Type	Description
`id`	`string (uuid) \| null`	Client-generated id; a replay returns the existing project.
`name`required	`string`
`client_id`	`string (uuid) \| null`	Billing authority; a client of the same organisation.
`hourly_rate`	`number \| string \| null`	Billing authority; requires `currency`.
`currency`	`string \| null`
`current_task`	`string`	Default: "".
`color`	`string \| null`
`tags`	`string[]`

ProjectOut

Fields of ProjectOut
Name	Type	Description
`id`required	`string (uuid)`
`legacy_id`required	`integer \| null`	Old integer id (old CLI selects projects by it).
`organisation_id`required	`string (uuid)`
`owner_user_id`required	`string (uuid)`
`name`required	`string`
`status`required	`"active" \| "archived"`
`archived_at`required	`string (date-time) \| null`
`client`required	`NamedRef \| null`
`tags`required	`TagRef[]`
`color`required	`string`	The caller's effective colour (own choice, else the derived default).
`hidden`required	`boolean`	The caller hid the project from pickers and trackers.
`current_task`required	`string`	The caller's current task, applied to their new sessions.
`billing`required	`ProjectBillingOut \| null`	Owners/admins only.
`stats`required	`ProjectStatsOut \| null`	Only when requested (`include_stats`).
`client_project_id`required	`string (uuid) \| null`	Legacy idempotency key sent by the old desktop app.
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`

ProjectRef

Fields of ProjectRef
Name	Type	Description
`id`required	`string (uuid)`
`name`required	`string`
`color`required	`string`	The caller's effective colour for the project.

ProjectSecondsOut

Fields of ProjectSecondsOut
Name	Type	Description
`project`required	`ProjectRef`
`client`required	`NamedRef \| null`
`seconds`required	`integer`
`session_count`required	`integer`
`share`required	`number`	Of the selection's total, 0 to 1.

ProjectStatsOut

The caller's own time on the project; teammates' sessions never count (ACL-04).

Fields of ProjectStatsOut
Name	Type	Description
`tracked_seconds`required	`integer`	Worked seconds, running sessions counted up to the response time.
`session_count`required	`integer`
`last_activity_at`required	`string (date-time) \| null`

ProjectUpdate

Only fields present change; `client_id`, `hourly_rate` and `currency` accept null.

Fields of ProjectUpdate
Name	Type	Description
`name`	`string \| null`
`client_id`	`string (uuid) \| null`
`hourly_rate`	`number \| string \| null`
`currency`	`string \| null`
`tags`	`string[] \| null`	Full replacement of the project's tags.

RateOverride

Fields of RateOverride
Name	Type	Description
`project_id`required	`string (uuid)`	A project in the selection.
`rate`required	`number \| string`
`save_to`	`"invoice" \| "project" \| "client" \| "org"`	Also store it as that level's default (INV-05). Default: "invoice".

ReportSummaryOut

Fields of ReportSummaryOut
Name	Type	Description
`scope`required	`"me" \| "org"`
`from_date`required	`string (date)`
`to_date`required	`string (date)`
`timezone`required	`string`
`as_of`required	`string (date-time)`
`mode`required	`"sessions" \| "day_span"`
`bucket`required	`"day" \| "week" \| "month"`
`totals`required	`ReportTotalsOut`
`previous`required	`ComparisonOut \| null`
`by_project`required	`ProjectSecondsOut[]`	Most time first, then name.
`by_client`required	`ClientSecondsOut[]`
`by_member`required	`MemberSecondsOut[] \| null`	`scope=org` only.
`by_task`required	`TaskSecondsOut[]`
`buckets`required	`BucketOut[]`
`timesheet`required	`TimesheetOut`
`billable`required	`BillableSplitOut \| null`	Billable and billed time with amounts per currency; owners/admins only.
`history_floor`required	`string (date-time) \| null`	Free plan: older parts of the range were clipped.

ReportTotalsOut

Fields of ReportTotalsOut
Name	Type	Description
`worked_seconds`required	`integer`	Running sessions included up to `as_of`.
`active_seconds`required	`integer`	The part of `worked_seconds` contributed by running sessions.
`tracked_days`required	`integer`	Local days with any session, even when fully paused.
`session_count`required	`integer`
`manual_session_count`required	`integer`
`avg_per_tracked_day_seconds`required	`integer \| null`	(worked - active) ÷ tracked days (WEB-14); null without tracked days.
`project_count`required	`integer`
`member_count`required	`integer`

ResolvedRate

An hourly rate after resolution: override → project → client → organisation → none.

Fields of ResolvedRate
Name	Type	Description
`rate`required	`string \| null`	Per hour, major units; null when nothing is configured (unpriced).
`currency`required	`string`
`source`required	`"invoice" \| "project" \| "client" \| "org" \| "none"`

SessionBillingOut

The invoice claiming the session; while set, the session is locked (tags stay editable).

Fields of SessionBillingOut
Name	Type	Description
`invoice_id`required	`string (uuid)`
`invoice_number`required	`string`
`issued`required	`boolean`	The invoice left draft: the claim can no longer be released.

SessionDetailOut

Fields of SessionDetailOut
Name	Type	Description
`id`required	`string (uuid)`
`user_id`required	`string (uuid)`
`organisation_id`required	`string (uuid)`
`project`required	`ProjectRef`
`start_at`required	`string (date-time)`
`end_at`required	`string (date-time) \| null`
`is_active`required	`boolean`
`is_paused`required	`boolean`
`origin`required	`"web" \| "desktop_file" \| "desktop_manual" \| "browser_url" \| "browser_manual" \| "cli_manual" \| "cli_watch" \| "api" \| "mcp" \| "mobile" \| "unknown"`
`is_manual`required	`boolean`
`description`required	`string`
`worked_seconds`required	`integer`	Pause-aware; a running session counts up to the response's `as_of`.
`tags`required	`TagRef[]`	Tags attached to the session itself.
`tasks`required	`TaskSummaryOut[]`
`files_changed`required	`integer \| null`	Distinct changed paths; null without file evidence.
`billing`required	`SessionBillingOut \| null`
`client_session_id`required	`string (uuid) \| null`	Legacy idempotency key of old clients.
`device_id`required	`string (uuid) \| null`
`continued_from_session_id`required	`string (uuid) \| null`	Set on the continuation of a live 24 h segment.
`deleted_at`required	`string (date-time) \| null`	Only set in change feeds (`changed_since`) and on deletion.
`version`required	`integer`	Increments on every change.
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`
`working_intervals`required	`IntervalOut[]`
`pauses`required	`PauseOut[]`
`task_segments`required	`TaskSegmentOut[]`
`inherited_tags`required	`TagRef[]`	Tags of the project and its client: filters match them.
`merged_from_session_ids`required	`string (uuid)[]`	Sources merged into this session (provenance).
`last_activity_at`required	`string (date-time) \| null`	Latest file evidence.
`review_flag`required	`string \| null`	Migration flag such as `over_24h` or `evidence_outside_window`.

SessionOut

Fields of SessionOut
Name	Type	Description
`id`required	`string (uuid)`
`user_id`required	`string (uuid)`
`organisation_id`required	`string (uuid)`
`project`required	`ProjectRef`
`start_at`required	`string (date-time)`
`end_at`required	`string (date-time) \| null`
`is_active`required	`boolean`
`is_paused`required	`boolean`
`origin`required	`"web" \| "desktop_file" \| "desktop_manual" \| "browser_url" \| "browser_manual" \| "cli_manual" \| "cli_watch" \| "api" \| "mcp" \| "mobile" \| "unknown"`
`is_manual`required	`boolean`
`description`required	`string`
`worked_seconds`required	`integer`	Pause-aware; a running session counts up to the response's `as_of`.
`tags`required	`TagRef[]`	Tags attached to the session itself.
`tasks`required	`TaskSummaryOut[]`
`files_changed`required	`integer \| null`	Distinct changed paths; null without file evidence.
`billing`required	`SessionBillingOut \| null`
`client_session_id`required	`string (uuid) \| null`	Legacy idempotency key of old clients.
`device_id`required	`string (uuid) \| null`
`continued_from_session_id`required	`string (uuid) \| null`	Set on the continuation of a live 24 h segment.
`deleted_at`required	`string (date-time) \| null`	Only set in change feeds (`changed_since`) and on deletion.
`version`required	`integer`	Increments on every change.
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`

SessionPage

Fields of SessionPage
Name	Type	Description
`items`required	`SessionOut[]`
`next_cursor`required	`string \| null`
`as_of`required	`string (date-time)`	The instant running sessions are measured to.
`totals`required	`SessionTotalsOut \| null`	Whole selection, not just this page; null in delta-sync mode.
`history_floor`required	`string (date-time) \| null`	Free plan: older parts of the range were clipped.

SessionStop

Fields of SessionStop
Name	Type	Description
`end_at`	`string (date-time) \| null`	Default now (clamped for stale file sessions); a set end only moves earlier.

SessionTotalsOut

Fields of SessionTotalsOut
Name	Type	Description
`session_count`required	`integer`
`active_count`required	`integer`
`worked_seconds`required	`integer`

SessionUpdate

Only fields present change; untouched instants round-trip exactly (TIM-05).

Fields of SessionUpdate
Name	Type	Description
`project_id`	`string (uuid) \| null`
`start_at`	`string (date-time) \| null`
`end_at`	`string (date-time) \| null`	Setting it on a running session stops it.
`duration_seconds`	`integer \| null`	Alternative to `end_at`, from the start.
`description`	`string \| null`	This session only; no cascade.
`tags`	`string[] \| null`	Full replacement of direct tags.

SettingsOut

Fields of SettingsOut
Name	Type	Description
`timezone`required	`string \| null`	Chosen IANA zone; null until the user (or detection) sets one.
`effective_timezone`required	`string`	The zone used for day boundaries: chosen zone or server default.
`idle_timeout_seconds`required	`integer`
`sleep_resume_seconds`required	`integer`
`full_day_span`required	`boolean`
`ai_sensitive_data_consent`required	`boolean`
`ui`required	`UiPreferences`

TagRef

Fields of TagRef
Name	Type	Description
`id`required	`string (uuid)`
`name`required	`string`

TaskHoursOut

Fields of TaskHoursOut
Name	Type	Description
`label`required	`string \| null`	Null is unlabelled work ("Other work").
`hours`required	`string`	Sums exactly to the line hours (largest remainder, INV-25).

TaskSecondsOut

Fields of TaskSecondsOut
Name	Type	Description
`name`required	`string \| null`	Null groups unlabelled time ("Other work").
`seconds`required	`integer`

TaskSegmentOut

Fields of TaskSegmentOut
Name	Type	Description
`id`required	`string (uuid)`
`name`required	`string`
`start_at`required	`string (date-time)`
`end_at`required	`string (date-time) \| null`
`seconds`required	`integer`

TaskSummaryOut

Fields of TaskSummaryOut
Name	Type	Description
`name`required	`string`
`seconds`required	`integer`	Pause-aware time of all segments with this name.
`active`required	`boolean`	The session's open segment carries this name.

TimeReportOut

The caller's own tracked time over a range, the running timer included.

Fields of TimeReportOut
Name	Type	Description
`from_date`required	`string (date)`
`to_date`required	`string (date)`
`timezone`required	`string`
`as_of`required	`string (date-time)`
`total_seconds`required	`integer`
`running_timer_included`required	`boolean`
`by_project`required	`ProjectSecondsOut[] \| null`	When grouped by project; most time first.
`by_day`required	`DaySecondsOut[] \| null`	When grouped by day; days with time, ascending.
`by_task`required	`TaskSecondsOut[] \| null`	When grouped by task.
`history_floor`required	`string (date-time) \| null`	Free plan: older parts of the range were clipped.

TimerSnapshot

The caller's own running sessions — never widened to teammates, also not for admins.

Fields of TimerSnapshot
Name	Type	Description
`as_of`required	`string (date-time)`
`sessions`required	`ActiveSessionOut[]`
`clients`required	`ConnectedClientOut[]`	The caller's connected live clients (presence).

TimerStart

Fields of TimerStart
Name	Type	Description
`id`	`string (uuid) \| null`	Client-generated id; a replay returns the same session.
`project_id`required	`string (uuid)`
`start_at`	`string (date-time) \| null`	Default now; at most 5 min in the future.
`description`	`string \| null`	Default: the caller's current task.
`origin`	`"web" \| "desktop_file" \| "desktop_manual" \| "browser_url" \| "browser_manual" \| "cli_manual" \| "cli_watch" \| "api" \| "mcp" \| "mobile"`	Default: "web".
`is_manual`	`boolean`	False for automatic starts (file activity, URL rules). Default: true.
`device_id`	`string (uuid) \| null`
`client_session_id`	`string (uuid) \| null`	Legacy idempotency key (old clients).
`replace_others`	`boolean`	Stop the caller's other running timers first. Default: false.

TimerStartOut

Fields of TimerStartOut
Name	Type	Description
`session`required	`SessionOut`
`created`required	`boolean`	This call created the session: the caller owns it.
`adopted`required	`boolean`	An open session already ran on the project and is returned instead. The caller did not start it and must not stop it automatically (TIM-10).
`stopped`required	`SessionOut[]`	Timers stopped because `replace_others` was set.

TimesheetOut

Fields of TimesheetOut
Name	Type	Description
`days`required	`string (date)[]`
`by_project`required	`TimesheetRowOut[]`
`by_member`required	`TimesheetRowOut[] \| null`	`scope=org` only.

TimesheetRowOut

Fields of TimesheetRowOut
Name	Type	Description
`id`required	`string (uuid)`	Project id, or user id in `by_member`.
`label`required	`string`
`seconds_by_day`required	`integer[]`	Aligned with `TimesheetOut.days`.
`total_seconds`required	`integer`

UiPreferences

Client display preferences, synced across devices; servers never act on them.

Fields of UiPreferences
Name	Type	Description
`theme`	`"system" \| "light" \| "dark"`	Default: "system".
`mobile_shortcuts`	`"today" \| "calendar" \| "sessions" \| "projects" \| "clients" \| "invoices" \| "reports" \| "team" \| "settings" \| "support"[]`	Ordered phone tab-bar shortcuts.
`sidebar_collapsed`	`boolean`	Default: false.
`calendar_view`	`"day" \| "week" \| "month"`	Default: "week".

UserOut

Fields of UserOut
Name	Type	Description
`id`required	`string (uuid)`
`legacy_id`required	`integer \| null`	Old integer id; installed clients key local data by it.
`email`required	`string`
`pending_email`required	`string \| null`	New address waiting for its confirmation link to be opened.
`first_name`required	`string`
`last_name`required	`string`
`display_name`required	`string`
`email_verified`required	`boolean`
`has_deliverable_email`required	`boolean`	False for social sign-ups with a placeholder address.
`has_password`required	`boolean`
`is_staff`required	`boolean`
`created_at`required	`string (date-time)`
`deletion_scheduled_at`required	`string (date-time) \| null`	Set while a requested deletion is in its grace period.

WebhookDeliveryOut

Fields of WebhookDeliveryOut
Name	Type	Description
`id`required	`string (uuid)`
`event_id`required	`string (uuid)`	The business event; shared by all its deliveries.
`event`required	`"project.created" \| "session.created" \| "session.closed" \| "invoice.created" \| "invoice.paid"`
`status`required	`"pending" \| "delivered" \| "dead" \| "cancelled"`
`attempts`required	`integer`
`next_attempt_at`required	`string (date-time) \| null`
`last_status_code`required	`integer \| null`
`last_error`required	`string \| null`
`created_at`required	`string (date-time)`
`delivered_at`required	`string (date-time) \| null`

WebhookSecretOut

Fields of WebhookSecretOut
Name	Type	Description
`secret`required	`string`

WebhookSubscriptionCreate

Fields of WebhookSubscriptionCreate
Name	Type	Description
`id`	`string (uuid) \| null`
`event`required	`"project.created" \| "session.created" \| "session.closed" \| "invoice.created" \| "invoice.paid"`
`target_url`required	`string`
`api_key_id`	`string (uuid) \| null`	Required with a cookie session; API-key callers subscribe their own key.

WebhookSubscriptionCreatedOut

Fields of WebhookSubscriptionCreatedOut
Name	Type	Description
`subscription`required	`WebhookSubscriptionOut`
`secret`required	`string`	HMAC-SHA256 key for `X-Temporalist-Signature`. Returned by a create and its replays (so a retried subscribe still learns it), never by reads; rotate to replace it.

WebhookSubscriptionOut

Fields of WebhookSubscriptionOut
Name	Type	Description
`id`required	`string (uuid)`
`api_key_id`required	`string (uuid)`
`event`required	`"project.created" \| "session.created" \| "session.closed" \| "invoice.created" \| "invoice.paid"`
`target_url`required	`string`
`status`required	`"active" \| "disabled"`
`failure_count`required	`integer`	Consecutive failed deliveries; reset by a success.
`last_delivery_at`required	`string (date-time) \| null`
`last_status_code`required	`integer \| null`
`last_error`required	`string \| null`
`created_at`required	`string (date-time)`

WebhookSubscriptionUpdate

Fields of WebhookSubscriptionUpdate
Name	Type	Description
`status`required	`"active" \| "disabled"`

OpenAPI

The complete machine-readable description of the API, for code generators and API tools such as Postman or Insomnia.

OpenAPI 3.1 document

https://temporal.ist/api/v2/openapi.json

Introduction

Authentication

Quickstart

Requests and responses

Errors

Receiving webhooks

Identity

GET/api/v2/me

Projects

GET/api/v2/projects

POST/api/v2/projects

GET/api/v2/projects/{project_id}

PATCH/api/v2/projects/{project_id}

POST/api/v2/projects/{project_id}/archive

POST/api/v2/projects/{project_id}/unarchive