Playbooks

List playbook cases

Returns a project's cases, newest first, without node states; read one case for those.

get/v1/projects/{project_id}/playbook-cases

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/playbook-cases
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Query parameters

playbook_idstring
Example:pbk_V1StGXR8Z5jdHi6B

Only the cases of this playbook

automation_statusPlaybookAutomationStatus[]

Only the cases in these automation statuses. Repeat the parameter to OR values. A value outside the enum, empty string included, is a 400.

limitinteger

Results per page, 1 to 100 (default 50). Above 100 it is clamped; below 1 or not an integer it is 400.

offsetinteger

Results to skip. Negative or not an integer it is 400.

Response

List of cases

totalinteger required
limitinteger required
offsetinteger required

Example response

{
  "data": [
    {
      "id": "pbk_case_V1StGXR8Z5jdHi6B",
      "project_id": "proj_V1StGXR8Z5jdHi6B",
      "playbook_id": "pbk_V1StGXR8Z5jdHi6B",
      "playbook_version": 1
    }
  ]
}

Changes

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