GET
/
orders
Get Orders
curl --request GET \
  --url https://api.usecobalt.com/v1/orders \
  --header 'access_token: <api-key>' \
  --header 'client_id: <api-key>' \
  --header 'client_secret: <api-key>'
{
  "success": true,
  "orders": [
    {
      "id": "<string>",
      "type": "lab",
      "status": "pending",
      "ordered_date": "2023-11-07T05:31:56Z",
      "details": {}
    }
  ]
}

​
Example Request

curl -X GET https://api.usecobalt.com/v1/orders \
-H 'Content-Type: application/json' \
-H 'client_id: ci_live_198908HJDKJSH98789OHKJL' \
-H 'client_secret: cs_live_9827hofdsklOYYHJLJh' \
-H 'access_token: 493JKLHIU98789hLKH9HHJH' \
-G \
--data-urlencode "patient_mrn=414421" \
--data-urlencode "start_date=2024-01-01" \
--data-urlencode "end_date=2024-03-31"

​
Example Response

{
    "success": true,
    "orders": [
        {
            "id": "ord_123456",
            "type": "lab",
            "status": "completed",
            "ordered_date": "2024-02-15T09:30:00Z",
            "details": {
                "name": "Comprehensive Metabolic Panel",
                "code": "CMP",
                "results_url": "https://results.example.com/cmp_123"
            }
        },
        {
            "id": "ord_789012",
            "type": "imaging",
            "status": "pending",
            "ordered_date": "2024-03-01T14:15:00Z",
            "details": {
                "name": "Chest X-Ray",
                "location": "Main Imaging Center",
                "scheduled_date": "2024-03-15T10:00:00Z"
            }
        }
    ]
}
The structure of the details object varies based on the order type.

Authorizations

​
client_id
string
header
required
​
client_secret
string
header
required
​
access_token
string
header
required

Query Parameters

​
patient_mrn
string
required

The medical record number of the patient

​
start_date
string<date>

Filter orders after this date (ISO 8601 format)

​
end_date
string<date>

Filter orders before this date (ISO 8601 format)

Response

200 - application/json

Successful response

The response is of type object.