Playbooks

Get a check

Retrieve a single check in a playbook by ID.

Readable by any caller who can read the playbook.

get/playbooks/{id}/checks/{checkId}

Request

Base URL
https://app.gc.ai/api/external/v1
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/gc-ai/apis/gc-ai-external-api/docs/playbooks/:id/checks/:checkId/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

Playbook ID from GET /playbooks.

checkIdstring uuid required

Check ID from GET /playbooks/{id}/checks.

Check details

idstring uuid required

Unique check identifier

titlestring required

Check title

descriptionstring nullable required

Optional internal description, or null if unset

importance'low' | 'medium' | 'high' | 'null' nullable required

Priority of this check within the playbook, or null if unset

created_atstring nullable required

ISO 8601 creation timestamp

updated_atstring nullable required

ISO 8601 last-update timestamp

No recorded changes to this operation across all 1 revision of this API.