## List clinical references

**get** `/v1/autoScribe/clinicalReferences`

Lists clinical references with cursor-based pagination and optional filters.

### Query Parameters

- `cursor: optional string`

  Base64 encoded cursor from previous response

- `expressCustomerId: optional string`

  Filter by Express customer ID. Omit for no filter; pass null for clinic-wide references

- `isActive: optional boolean`

  Filter by active status. Defaults to true (active references only). Pass false to list inactive references.

- `limit: optional number`

  Number of results to return (1-100)

- `type: optional ClinicalReferenceType`

  Filter by clinical reference type

  - `"facility"`

  - `"referring_provider"`

  - `"study_description"`

  - `"procedure"`

### Returns

- `clinicalReferences: array of ClinicalReference`

  - `clinicalReferenceId: string`

    Unique clinical reference identifier. Format: ref_{32-hex-chars}

  - `createdAt: string`

    Timestamp when the clinical reference was created

  - `isActive: boolean`

    Whether this reference is active and available for pickers

  - `name: string`

    Canonical display name for this reference value

  - `type: ClinicalReferenceType`

    Category of canonical clinical reference value used for study workflow pickers and normalization.

    - `"facility"`

    - `"referring_provider"`

    - `"study_description"`

    - `"procedure"`

  - `updatedAt: string`

    Timestamp when the clinical reference was last updated

  - `expressCustomer: optional ExpressCustomerReference`

    A reference to an Express customer with basic identifying information

    - `expressCustomerId: string`

      Unique Express customer identifier. Format: cus_{32-hex-chars}

    - `expressCustomerName: string`

      Name of the Express customer

  - `externalReferenceId: optional string`

    Integrator-provided stable identifier for mapping inbound data

  - `metadata: optional map[string]`

    Optional key-value metadata. Maximum 50 pairs

- `hasMore: boolean`

- `cursor: optional string`

### Example

```http
curl https://api.avarasoftware.com/v1/autoScribe/clinicalReferences \
    -H "Authorization: Bearer $AVARA_API_KEY"
```

#### Response

```json
{
  "clinicalReferences": [
    {
      "clinicalReferenceId": "ref_1234567890abcdef1234567890abcdef",
      "createdAt": "2024-01-15T09:00:00Z",
      "isActive": true,
      "name": "City Medical Center",
      "type": "facility",
      "updatedAt": "2024-03-15T14:20:00Z",
      "expressCustomer": {
        "expressCustomerId": "cus_1234567890abcdef1234567890abcdef",
        "expressCustomerName": "City Medical Center"
      },
      "externalReferenceId": "FAC-001",
      "metadata": {
        "region": "northeast"
      }
    }
  ],
  "hasMore": true,
  "cursor": "cursor"
}
```