Rulebooks
List rulebooks
GET
/api/v1alpha1/rulebooksReturns the rulebooks you can use, most recently updated first.
- Access: an alpha-enabled API key with the
MANAGE_RULEBOOKSpermission. - Contents: the rulebooks this key owns in the workspace, plus the shared templates anyone can start from.
- Paging:
limitdefaults to 25, maximum 100. Passnext_cursorback unchanged ascursor.
canEdit and canDelete on each row tell you which ones you may change. Templates are always read-only.
Authorization
apiKey AuthorizationBearer <token>
In: header
Query Parameters
cursor?string
Opaque cursor returned as next_cursor by the previous response. Pass it byte-for-byte as cursor; do not decode, edit, or construct it.
limit?number
Number of resources to return in one page. The default is 25 and the accepted range is 1-100.
Format
int32Range
1 <= value <= 100Default
25Response 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" \ -H "Authorization: Bearer $DEEPFRAME_API_KEY"{ "data": [ { "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" } ], "has_more": false, "next_cursor": "MDEyMzQ1Njc4OWFitSLKnTQIcJAwDPi07V5EGs76Im3F8rCuUshrBnHuUJY7_8Ie8Stea_TKuhKhDw5XkRdkBI3IKkvsKT9Kp60Wpx7CoTCGQW8FnalDILVbuy8wxvWWf_B8SA"}