Get

GET

/operations/operations_tasks/v1/:task_id

GET

/operations/operations_tasks/v1/:task_id

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.operations.operationsTasks.getV1("task_id");
}
main();

{
  "_id": "_id",
  "description": "description",
  "order_id": "order_id",
  "order_short_id": "order_short_id",
  "org_id": "org_id",
  "schema_version": 1,
  "task_type": "review_order_details",
  "title": "title",
  "assigned_user_ids": [
    "assigned_user_ids"
  ],
  "comments": [
    {
      "comment": "comment",
      "timestamp": "2024-01-15T09:30:00Z",
      "user_id": "user_id",
      "id": "id"
    }
  ],
  "completed_at_timestamp": "2024-01-15T09:30:00Z",
  "completed_by_user_id": "completed_by_user_id",
  "deadline_timestamp": "2024-01-15T09:30:00Z",
  "department_id": "department_id",
  "entry_tag": "entry_tag",
  "order_off_chrt_reference_id": "order_off_chrt_reference_id",
  "source_task_list_id": "source_task_list_id",
  "status": "not_started"
}

Retrieves a single OperationsTask by id. | authz: min_org_role=operator | () -> (OperationsTask1)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

task_idstringRequired

Response

Successful Response

_idstring

descriptionstring<=8192 characters

order_idstring

order_short_idstring

org_idstring

Must be a string starting with org_

schema_versioninteger

task_typeenum

Coarse functional buckets a dispatcher batch-processes (powers the per-type functional-queue index). Granular SOP specifics live in the Task’s title/description, not here.

Ordered roughly along the shipment lifecycle (review -> research -> book -> track/verify -> contact -> billing). The buckets are the distinct modes of work an operator sits down and batches; the exact SOP step (e.g. “Send Shipping Label”, “CBC Call”, “Get Pack Time”) is captured in the title.

Contact is split by who (customer, agent, airline, other), not by channel (call vs. email) — the recipient is what a dispatcher batches around, and the channel is captured in title/description detail.

titlestring<=512 characters

assigned_user_idslist of stringsOptional

commentslist of objectsOptional

completed_at_timestampdatetime or nullOptional

completed_by_user_idstring or nullOptional

Must be a string starting with user_

deadline_timestampdatetimeOptional

department_idstring or nullOptional

entry_tagstring or nullOptional

order_off_chrt_reference_idstring or nullOptionalformat: "^[A-Za-z0-9._~\-]{1,64}$"1-64 characters

Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, ’.’, ’_’, ’~’, ’-’ (RFC 3986 unreserved).

source_task_list_idstring or nullOptional

statusenumOptional

Operator-driven lifecycle of an operations task.

Manually driven by operators for now (no automatic transitions). Kept structurally parallel to the Check status model in anticipation of the eventual Task <-> Check merge.

Errors

422

Operations Tasks Get V1request Unprocessable Entity Error