---
title: "Get Tasks Definitions List"
method: GET
path: "/orders/tasks-definitions"
tags: ["Orders"]
---

# Get Tasks Definitions List

`GET /orders/tasks-definitions`

## Request

- Base URL: `https://v3.api.hypertrack.com`
- URL: `https://v3.api.hypertrack.com/orders/tasks-definitions`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/hypertrack/apis/hypertrack-api/docs/orders/tasks-definitions/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Query parameters

- `search_term` string, nullable
- `ops_group_handle` string, nullable
- `metadata` string, nullable
- `pagination_token` string, nullable
- `limit` integer, nullable

## Response `200`

Successful response

- TasksDefinitionListResponse
  - `task_definitions` TasksDefinitionResponse[], required: List of task definitions available in the system.
    - `label` string, required: Name of the task definition.
    - `ops_group_handle` string, nullable: Ops group associated with this definition
    - `tasks` BaseOrderTask[], required: List of tasks part of this definition.
      - `label` string, required: Type of task to be created for the order.
      - `task_definition_id` string, nullable: Id of the tasks definition from which this task is picked
      - `description` string, nullable: Description of the task type.
      - `metadata` object, nullable: Additional metadata for the task.
      - `priority` 'none' | 'low' | 'medium' | 'high' | 'null', nullable: Priority of the task. Valid values are none, low, medium, high.
    - `metadata` object, nullable: Additional metadata for this definition.
    - `task_definition_id` string, required: Unique identifier for the task definition.
    - `created_at` string, required: Timestamp when the task definition was created.
    - `updated_at` string, nullable: Timestamp when the task definition was last updated.
  - `pagination_token` string, nullable: Token for pagination, used to fetch the next set of results.

## Other responses

- `400`: Validation error
- `401`: Authentication error

---

[API](https://skmtc.dev/hypertrack/apis/hypertrack-api.md) - [All operations](https://skmtc.dev/hypertrack/apis/hypertrack-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hypertrack/apis/hypertrack-api/revisions/389326c4c9c8?raw)
