## List clinical references

`ClinicalReferenceListPage autoScribe().clinicalReferences().list(ClinicalReferenceListParamsparams = ClinicalReferenceListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

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

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

### Parameters

- `ClinicalReferenceListParams params`

  - `Optional<String> cursor`

    Base64 encoded cursor from previous response

  - `Optional<String> expressCustomerId`

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

  - `Optional<Boolean> isActive`

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

  - `Optional<Double> limit`

    Number of results to return (1-100)

  - `Optional<ClinicalReferenceType> type`

    Filter by clinical reference type

### Returns

- `class ClinicalReference:`

  A canonical clinical reference value for study workflow pickers and normalization

  - `String clinicalReferenceId`

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

  - `Optional<LocalDateTime> createdAt`

    Timestamp when the clinical reference was created

  - `boolean isActive`

    Whether this reference is active and available for pickers

  - `String name`

    Canonical display name for this reference value

  - `ClinicalReferenceType type`

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

    - `FACILITY("facility")`

    - `REFERRING_PROVIDER("referring_provider")`

    - `STUDY_DESCRIPTION("study_description")`

    - `PROCEDURE("procedure")`

  - `Optional<LocalDateTime> updatedAt`

    Timestamp when the clinical reference was last updated

  - `Optional<ExpressCustomerReference> expressCustomer`

    A reference to an Express customer with basic identifying information

    - `String expressCustomerId`

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

    - `String expressCustomerName`

      Name of the Express customer

  - `Optional<String> externalReferenceId`

    Integrator-provided stable identifier for mapping inbound data

  - `Optional<Metadata> metadata`

    Optional key-value metadata. Maximum 50 pairs

### Example

```java
package com.avarasoftware.example;

import com.avarasoftware.client.AvaraClient;
import com.avarasoftware.client.okhttp.AvaraOkHttpClient;
import com.avarasoftware.models.autoscribe.clinicalreferences.ClinicalReferenceListPage;
import com.avarasoftware.models.autoscribe.clinicalreferences.ClinicalReferenceListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        ClinicalReferenceListPage page = client.autoScribe().clinicalReferences().list();
    }
}
```

#### 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"
}
```