This example shows you how to retrieve completed runbooks and their associated tasks, streams, and teams so you can store the data in your own repository for reporting, retention, or audit purposes.
1. Identify the workspace
First, retrieve the workspaces available to you by making an authenticated call to the List Workspaces endpoint:
GET /core/workspaces
The response includes the workspace IDs you can use to retrieve runbooks.
2. Retrieve completed runbooks
Use the workspace ID to retrieve the runbooks you want to export:
GET /core/runbooks?workspace_id={workspace_id}&actual_completion_after={timestamp}
The actual_completion_after parameter lets you retrieve runbooks completed after a specific date and time.
For example:
GET /core/runbooks?workspace_id=123&actual_completion_after=2026-07-01T00:00:00Z
The response contains the runbook IDs and other information you need to retrieve the runbook data.
3. Retrieve the tasks
For each runbook, retrieve its tasks using the List Runbook Tasks endpoint:
GET /core/runbooks/{runbook_id}/tasks
The response contains the tasks and their attributes, including timings, completion details, and custom field values.
4. Retrieve streams and teams
You can also retrieve the streams and teams associated with each runbook:
GET /core/runbooks/{runbook_id}/streams GET /core/runbooks/{runbook_id}/runbook_teams
You can now combine these responses and store the runbook data in your own repository.
Tip: Store the raw API responses alongside any resolved version of the data to preserve the original API information for audit purposes.
