---
title: "Get Rate Limit Configuration"
method: GET
path: "/v1/rate-limits/config"
tags: ["Configuration"]
---

# Get Rate Limit Configuration

`GET /v1/rate-limits/config`

## 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/rate-limits/config`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.hhaexchange.com/v1/fhir/auth/token` scopes: `read`

Retrieve the rate limit configuration for a specific client, agency, and environment combination. The triple (ClientId, AgencyId, Env) uniquely identifies one ClientMapping row on SB/PROD. On QA/IMPL (single HHA mirror), the resolved mapping may use a different stored Env than the query parameter; see response `Data.Env`. Returns the per-second or per-minute request limit stored on that mapping. Falls back to application defaults (50 / Minute) when no explicit configuration has been saved.

## Query parameters

- `ClientId` string, nullable: FHIR client UUID (required). Example: 9b2f1a6e-3c84-4d8e-9b8a-7e2c9f2a1c45
- `AgencyId` string, nullable: Agency (vendor) identifier — required; must be a positive integer
- `Env` string, nullable: HHA environment (required): app, app2, or cloud

## Response `200`

Successful Response

- RateLimitConfigResponse: Wrapper for GET /rate-limits/config response.
  - `Message` string, required: Response message
  - `Data` RateLimitConfigData, required: Rate limit configuration for one unique client + agency + env combination.
    - `ClientId` string, required: FHIR client UUID
    - `ClientMappingId` integer, required: FHIR.ClientMappings primary key
    - `Env` string, required: HHA environment for this mapping (app, app2, cloud)
    - `Agency` AgencyRateLimitDetail, required: Per-agency portion of the rate limit config response.
      - `AgencyId` integer, required: Agency (vendor) identifier
      - `RateLimit` integer, required: Allowed requests per RateLimitWindow
    - `RateLimitWindow` string, required: Rate window granularity (Second, Minute)

## 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)