List frozen months

GET /api/v2/external/exchange-rate-freezes

Authentication: x-api-key header, with the exchange-rate-freezes:write scope. See Authentication and limits.

Paginated list of the months (YYYY-MM) for which the client has frozen exchange rates, in the standard v2 list envelope.

Query parameters

Name	Type	Required	Description
itemsPerPage	number	No	Number of items per page. Default 10; values above 100 are silently clamped to 100 (hard server cap, spec §6.1).
currentPage	number	No	Current page (1-based). Offset pagination: a page can shift if the collection mutates between calls; re-fetch from page 1 for a consistent sweep.

Response

200 A page of frozen months with the standard v2 list envelope { pagination, data }.

{
  "pagination": {
    "totalItems": 128,
    "currentPage": 1,
    "itemsPerPage": 10,
    "totalPages": 13,
    "hasMore": true
  },
  "data": [
    {
      "object": "exchangeRateFreeze",
      "yearMonth": "2026-10"
    }
  ]
}

Response fields

Field	Type	Description
pagination	object	Pagination metadata.
pagination.totalItems	integer	Total number of items across all pages.
pagination.currentPage	integer	1-based index of the current page.
pagination.itemsPerPage	integer	Number of items per page (server cap: 100).
pagination.totalPages	integer	Total number of pages.
pagination.hasMore	boolean	True when another page exists after the current one.
data	array of objects	Page of results.
data[].object	string	String describing the object type (auto-description). One of: exchangeRateFreeze.
data[].yearMonth	string	Frozen month, YYYY-MM.

Errors

Errors use the application/problem+json envelope with stable machine-readable codes. See the Errors guide.

Status	Description
401	Missing or invalid API key (invalid_api_key), or expired key (api_key_expired).
403	API key lacks the required scope (insufficient_scope, with requiredScope extension) or the operation is not enabled for this client (forbidden).
429	Daily API call limit exceeded (rate_limit_exceeded): the Retry-After header gives the seconds until reset.

Example request

curl "https://api.renewr.example/api/v2/external/exchange-rate-freezes" \
  -H "x-api-key: $RENEWR_API_KEY"