# List lab orders

Operation ID: `connectors.steadymdListLabOrders`

GET /v1/labOrder — List lab orders.

## Public method

`listLabOrders`

Signature: `connectors.steadymd.createClient(config).listLabOrders(body)`

Return type: `Promise<SteadyMDListLabOrdersResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/steadymd/list-lab-orders`

## Path parameters

None.

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`SteadyMDListLabOrdersRequest`](../models/SteadyMDListLabOrdersRequest.md) | Yes |  |  |  | No |  |

Request model: [`SteadyMDListLabOrdersRequest`](../models/SteadyMDListLabOrdersRequest.md)

## Request example

```json
{
  "api_key": "example-api-key",
  "api_url": "https://partner-api.steadymd.com",
  "episode_guid": "",
  "limit": 10,
  "mode": "sandbox"
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`SteadyMDLabOrderListResponse`](../models/SteadyMDLabOrderListResponse.md) | application/json | Successful response |

## Success response examples

### 200

```json
{
  "count": 84,
  "next": "https://partner-api.steadymd.com/v1/labOrder?limit=10&offset=10",
  "results": [
    {
      "emr_uri": "steadymd://episode/d65f1cad-782e-4afe-b002-81d274af0e7e/lab/order/e3c16e47-4126-431d-a04e-7465670372dc",
      "episode_guid": "example-episode_guid",
      "guid": "example-guid",
      "lab_requisitions": [
        {
          "guid": "example-guid",
          "lab_order_code": "001453",
          "lab_order_name": "Hemoglobin A1c2"
        }
      ],
      "laboratory": "LABCORP",
      "patient_guid": "example-patient_guid",
      "payment_responsibility": "patient",
      "submission_method": "SELF_SUBMISSION"
    }
  ]
}
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Connector validation rejected the payload, or a required field was missing or of the wrong type. |
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The HealthCloud bearer token is missing or invalid, or the vendor rejected the supplied connector credentials. |
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The connector failed unexpectedly. |
| `502` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor returned an application or transport-level failure. |
| `504` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor did not respond within the connector timeout. |

## Error examples

### 400 — Invalid request

```json
{
  "error": "Invalid request"
}
```

### 401 — Authorization required

```json
{
  "error": "Authorization required"
}
```

### 500 — Internal error

```json
{
  "error": "Internal error"
}
```

### 502 — Upstream vendor error

```json
{
  "error": "Upstream vendor error"
}
```

### 504 — Upstream timeout

```json
{
  "error": "Upstream timeout"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
import type { SteadyMDListLabOrdersRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "api_key": "example-api-key",
  "api_url": "https://partner-api.steadymd.com",
  "episode_guid": "",
  "limit": 10,
  "mode": "sandbox"
};

const result = await connectors.steadymd.createClient(config).listLabOrders(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"api_key":"example-api-key","api_url":"https://partner-api.steadymd.com","episode_guid":"","limit":10,"mode":"sandbox"}' \
  'https://dev-api-connectors.health.cloud/connectors/steadymd/list-lab-orders'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.