v1
latestOpenAPI 3.1.02026-07-1382339.6 KBInternal
Get generic references
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.
get/v1/internal/generic-references
Query parameters
ClientIdstring required
Client ID (mandatory)
Client ID (mandatory)
XApiKeystring required
API key (mandatory)
API key (mandatory)
ProviderIdinteger required
Provider ID / Vendor ID (CompanyID) (mandatory)
Provider ID / Vendor ID (CompanyID) (mandatory)
ReferenceTypestring required
Reference type (e.g., 'EmergencyContactRelationship') (mandatory)
Reference type (e.g., 'EmergencyContactRelationship') (mandatory)
Response
Successful Response