v4

Swagger 2.02026-08-0343714211.7 MB
holiday_regions
Holiday Regions

List all possible holiday regions

List all possible holiday regions

get/holiday_regions/supported

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

Response

A list of HolidayRegions objects.

codestring

The code representing a region

namestring

The name of the region

Example response

[
  {
    "code": "us_dc",
    "name": "United States - District of Columbia"
  }
]