Skip to main content
GET
/
v1
/
api
/
schedules
/
{id}
Get a schedule
curl --request GET \
  --url https://api.hq.zone/v1/api/schedules/{id} \
  --header 'Authorization: Bearer <token>'
{
  "args": "<unknown>",
  "consecutive_failure_count": 123,
  "failure_count": 123,
  "fire_count": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state": "<string>",
  "trigger": "<unknown>",
  "description": "<string>",
  "last_fire_at": "2023-11-07T05:31:56Z",
  "last_fire_lag_ms": 123,
  "last_fire_status": "<string>",
  "last_run_conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "next_fire_at": "2023-11-07T05:31:56Z",
  "owner_display_name": "<string>",
  "owner_external_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Path Parameters

​
id
string<uuid>
required

Schedule id

Response

Schedule detail

​
args
any
required
​
consecutive_failure_count
integer<int32>
required
​
failure_count
integer<int32>
required
​
fire_count
integer<int32>
required
​
id
string<uuid>
required
​
name
string
required
​
owner_user_id
string<uuid>
required
​
state
string
required
​
trigger
any
required
​
description
string | null
​
last_fire_at
string<date-time> | null
​
last_fire_lag_ms
integer<int64> | null
​
last_fire_status
string | null
​
last_run_conversation_id
string<uuid> | null

The conversation backing this schedule's most recent run, if any. Scheduled-run threads are hidden from the main conversation list; the Schedules page uses this to offer a read-only "last run" link.

​
next_fire_at
string<date-time> | null
​
owner_display_name
string | null
​
owner_external_id
string | null