Rulebooks
Get a rulebook
GET
/api/v1alpha1/rulebooks/{rulebook_id}Returns one rulebook with all of its rules.
- Access: an alpha-enabled API key with the
MANAGE_RULEBOOKSpermission. - Reach: a rulebook this key owns, or a shared template.
- Not found: a rulebook belonging to somebody else is deliberately indistinguishable from one that does not exist.
Authorization
apiKey AuthorizationBearer <token>
In: header
Path Parameters
rulebook_id*string
Identifier of a rulebook your key can read.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/v1alpha1/rulebooks/rb_0190b5d4-7e1f-7a2b-9c3d-1234567890ab" \ -H "Authorization: Bearer $DEEPFRAME_API_KEY"{ "can_delete": true, "can_edit": true, "content": "Inspect every emergency exit.", "created_at": "2026-08-10T10:05:00.000Z", "created_by": "user_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "has_active_workflow_run": false, "id": "rb_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "is_template": false, "name": "Warehouse Safety", "owner_id": "user_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "rules": [ { "description": "The exit remains unobstructed.", "id": "SEC-04", "title": "Emergency exit is clear.", "version": 2 } ], "template_key": "template_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "updated_at": "2026-08-10T10:06:00.000Z", "updated_by": "user_0190b5d4-7e1f-7a2b-9c3d-1234567890ab"}