Sign in

v1

latestOpenAPI 3.1.02026-07-1382339.6 KB
Onboarding
Onboarding

Get Client Onboarding Details

Retrieve the complete onboarding configuration for an existing FHIR client.

get/v1/fhir-onboarding/client/{client_id}

Path parameters

client_idstring required

Unique identifier of the client whose onboarding details are to be retrieved

Unique identifier of the client whose onboarding details are to be retrieved

Response

Successful Response

Messagestring required

Response message

Example response

{
  "Data": {
    "AgencyUsers": [
      {
        "AgencyId": 123,
        "Env": "app",
        "ProviderTaxId": "12-3456789",
        "RateLimit": 50,
        "RateLimitWindow": "Minute",
        "UserId": -6789,
        "UserName": "FHIRAPIUser_1_123"
      },
      {
        "AgencyId": 678,
        "Env": "app2",
        "RateLimit": 50,
        "RateLimitWindow": "Minute",
        "UserId": -4567,
        "UserName": "FHIRAPIUser_1_678"
      },
      {
        "AgencyId": 789,
        "Env": "cloud",
        "RateLimit": 100,
        "RateLimitWindow": "Second",
        "UserId": -8765,
        "UserName": "FHIRAPIUser_1_789"
      }
    ],
    "ClientId": "9b2f1a6e-3c84-4d8e-9b8a-7e2c9f2a1c45",
    "ClientName": "Client 1",
    "ClientType": "FhirProvider",
    "CreatedAt": "2026-01-12T07:45:30Z",
    "Description": "HHAx Client",
    "RateLimitingPlan": "Basic",
    "Status": "Active",
    "UpdatedAt": "2026-01-12T09:10:15Z",
    "XApiKey": "brcRWv6qZQanfxwoZYvuYpMpfTUsvxEnkli2n998"
  },
  "Message": "Client onboarding details retrieved successfully"
}