Skip to content

List Review Playbooks

GET /review-playbooks

Every playbook the caller can reach, including the wider ones it resolves through.

A workspace caller sees its organization’s and the platform’s, because that is what most-specific-wins means (§10) — a listing that hid them would make “why did the review use those instructions” unanswerable from the API.

NameInTypeNotes
qquerystring | nulloptionalsubstring of slug or name
scopequeryworkspace | organization | platform | nulloptionalthe playbook’s own level
is_defaultqueryboolean | nulloptional—
is_activequeryboolean | nulloptional—
limitqueryintegeroptionalDefault 50. min 1 max 200
cursorquerystring | nulloptional—
offsetqueryinteger | nulloptionalmin 0
StatusDescriptionBody
200Successful ResponsePage_ReviewPlaybookView_
422Validation ErrorHTTPValidationError
Terminal window
curl -X GET https://your-deployment.example.com/review-playbooks \
-H "Authorization: Bearer $COBRE_TOKEN"
FieldTypeNotes
itemsReviewPlaybookView[]required—
next_cursorstring | nulloptional—
totalinteger | nulloptional—