curl --request GET \
--url https://api.hq.zone/v1/api/schedules/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hq.zone/v1/api/schedules/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hq.zone/v1/api/schedules/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hq.zone/v1/api/schedules/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hq.zone/v1/api/schedules/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hq.zone/v1/api/schedules/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hq.zone/v1/api/schedules/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"args": "<unknown>",
"consecutive_failure_count": 123,
"failure_count": 123,
"fire_count": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"max_duration_secs": 123,
"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>"
}Get a schedule
Returns the full detail of a single schedule by id, including its name, description, trigger, run arguments, current lifecycle state, fire and failure counts, last and next fire times, and a link to the conversation from its most recent run. The schedule is only returned if the caller owns it or is an admin; otherwise a 404 is returned. Requires the schedules:read scope.
curl --request GET \
--url https://api.hq.zone/v1/api/schedules/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hq.zone/v1/api/schedules/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hq.zone/v1/api/schedules/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hq.zone/v1/api/schedules/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hq.zone/v1/api/schedules/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hq.zone/v1/api/schedules/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hq.zone/v1/api/schedules/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"args": "<unknown>",
"consecutive_failure_count": 123,
"failure_count": 123,
"fire_count": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"max_duration_secs": 123,
"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
Personal Access Token. Send as Authorization: Bearer hq_pat_....
Path Parameters
Schedule id
Response
Schedule detail
Wall-clock cap per fire (seconds). A fire that runs past it is killed and marked failed. Editable; default 1800.
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.