Craft icon

Craft

Interact with your Craft documents via the API

Task → List Tasks

AI-generated

Summary

List tasks from your Craft workspace filtered by their scope, such as active, upcoming, inbox, or logbook tasks.

Inputs

  • Task Scope (required) — Select the scope of tasks to retrieve: Active tasks, Upcoming tasks, Inbox-only tasks, or Logbook-only tasks.

Output shape

a list of task objects matching the selected scope

The returned data contains tasks filtered by the specified scope option. Ensure that your Craft API credentials have appropriate permissions for reading tasks. Errors for unsupported operations or insufficient permissions are thrown as node errors.

Examples

Example 1: Retrieve active tasks from your Craft documents and inbox to process pending work items.

Set Resource to 'Task', Operation to 'List Tasks', and Task Scope to 'Active'.

Discussion