Get Tasks Definitions List
Retrieves a list of all task definitions available in the system. This endpoint is used to view all task definitions that can be used for orders.
Retrieves a list of all task definitions available in the system. This endpoint is used to view all task definitions that can be used for orders.
In: header
Query Parameters
Filter task definitions by label. Use this to search for task definitions with label containing search term.
Filter task definitions by ops group handle.
Filter task definitions by metadata. Use this to search for task definitions with metadata containing the specified key-value pairs.
Token for pagination. Use this to fetch the next set of results if available.
Maximum number of task definitions to return. Default is 100, maximum is 100.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/orders/tasks-definitions"{ "task_definitions": [ { "task_definition_id": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f", "label": "order_tasks_definition 1", "tasks": [ { "label": "order_summary", "description": "Generate order summary for order 001", "priority": "high" }, { "label": "order_billing_summary", "description": "Generate billing summary for order 001", "priority": "medium" } ], "created_at": "2023-10-01T12:00:00Z", "updated_at": "2023-10-01T12:00:00Z" } ], "pagination_token": null}{ "detail": {}, "message": "string"}{ "detail": { "<location>": { "<field_name>": [ "string" ] } }, "message": "string"}Get export job status GET
Check the status of an export job by job_id. Returns current status, progress, and download URL when completed.
Create Tasks Definition POST
Creates a new task definition for an order. This endpoint is used to define the structure and requirements of tasks that can be created for orders.