Retrieve task details for reporting and integrations

This example shows you how to retrieve all the tasks within a runbook so you can use task information in your own applications, reports, or integrations.

‍

1. Identify the runbook

You'll need the ID of the runbook whose tasks you want to retrieve. For example, let's retrieve the tasks from runbook 12345.

‍

2. Retrieve the tasks

Make an authenticated call to the List Runbook Tasks endpoint:

‍

GET /core/runbooks/12345/tasks

‍

The response contains the tasks in the runbook and their attributes, including:

  • Task name and description
  • Planned, start, and completion times
  • Task type
  • Stream
  • Assigned users
  • Custom field values
  • Completion details

3. Retrieve additional pages

Task results are paginated. If the response contains additional pages, continue requesting them using the page[number] parameter:

‍

GET /core/runbooks/12345/tasks?page[number]=2

‍

Continue until you've retrieved all the tasks in the runbook. You can now use the task data in your application or store it alongside the rest of your runbook data.

‍

Note: Some task attributes reference other Cutover objects by ID. See Resolve API IDs into meaningful names to learn how to resolve these IDs.

‍