Get tasking order details

get

Returns detailed tasking order information, including customer fields, capture preferences, notes, and per-product status details.

Authorizations

x-api-keystringRequired

API key passed via request header. Either this or the api_key query parameter is required.

Path parameters

spexi_order_idstring · min: 1Required

Spexi-assigned order identifier to look up.

Example: SPX-20260625-ABC123

Responses

200

Tasking order details.

application/json

spexi_order_idstringRequired

Spexi-assigned order identifier.

external_order_idstring · nullableRequired

Caller-supplied external order id, or null if none was set.

customer_org_namestringRequired

Name of the customer organization that placed the order.

customer_first_namestringRequired

First name of the primary customer contact.

customer_last_namestringRequired

Last name of the primary customer contact.

customer_emailstring · emailRequired

Email of the primary customer contact.

submitted_atstring · date-timeRequired

ISO-8601 timestamp when the order was submitted.

preferred_capture_startstring · date-time · nullableRequired

Preferred capture window start (ISO-8601), or null if unset.

preferred_capture_endstring · date-time · nullableRequired

Preferred capture window end (ISO-8601), or null if unset.

notesstring · nullableRequired

Free-form notes supplied with the order, or null if none.

401

Missing or invalid authentication credentials.

403

Caller lacks permission to access tasking orders.

404

No order matches the given spexi_order_id for the caller's organization.

get/developer-api/api/v1/order/tasking/{spexi_order_id}

GET /developer-api/api/v1/order/tasking/{spexi_order_id} HTTP/1.1
Host: world.spexi.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "spexi_order_id": "text",
  "external_order_id": "text",
  "customer_org_name": "text",
  "customer_first_name": "text",
  "customer_last_name": "text",
  "customer_email": "[e-mail]",
  "submitted_at": "2026-01-01T00:00:00.000Z",
  "preferred_capture_start": "2026-01-01T00:00:00.000Z",
  "preferred_capture_end": "2026-01-01T00:00:00.000Z",
  "notes": "text",
  "order_products": [
    {
      "product_type": "panorama",
      "product_sub_type": "standard",
      "status": "submitted",
      "updated_at": "2026-01-01T00:00:00.000Z",
      "zones": [
        {
          "index": "8a2a1072b4b7fff",
          "status": "uncaptured"
        }
      ]
    }
  ]
}