---
title: "Get generic references"
method: GET
path: "/v1/internal/generic-references"
tags: ["Internal"]
---

# Get generic references

`GET /v1/internal/generic-references`

## Request

- Base URL: `https://api.hhaexchange.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.hhaexchange.com/v1/internal/generic-references`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.hhaexchange.com/v1/fhir/auth/token` scopes: `read`

Returns generic references from HHA GenericReferences table by CompanyID (ProviderId/VendorId) and ReferenceType. Client ID and API key are required for authentication and to determine the correct HHA database environment. Returns all active reference records matching the specified CompanyID and ReferenceType.

## Query parameters

- `ClientId` string, required: Client ID (mandatory)
- `XApiKey` string, required: API key (mandatory)
- `ProviderId` integer, required: Provider ID / Vendor ID (CompanyID) (mandatory)
- `ReferenceType` string, required: Reference type (e.g., 'EmergencyContactRelationship') (mandatory)

## Response `200`

Successful Response

- GenericReferencesResponse: Response for GET /internal/generic-references: list of generic references by CompanyID and ReferenceType.
  - `CompanyID` integer, required
  - `ReferenceType` string, required
  - `References` GenericReferenceItem[]
    - `ReferenceCode` string, required
    - `Seq` integer, required
    - `ReferenceValue` string

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/hhaexchange/apis/hhaexchange-api.md) - [All operations](https://skmtc.dev/hhaexchange/apis/hhaexchange-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hhaexchange/apis/hhaexchange-api/revisions/f754b29e3de5?raw)