Get public holidays
GET /api/public-holiday
Gets all default public holidays for a given country.
Request
Query parameters
country string Required
The country, formatted as an ISO Alpha-2 code.
Example: JP
customer_id string Required
The unique Marco identifier for your company.
start_date string Optional
Start date for the date range filter, formatted as YYYY/MM/DD. Only public holidays after the selected start date will be returned.
Example: 2023/01/31
end_date string Optional
End date for the date range filter, formatted as YYYY/MM/DD. Only public holidays before the selected end date will be returned.
Example Requests
Response (200)
{public_holiday} object
The public holidays.
{public_holiday}.items array[object]
Contains a list of public holidays based on the request parameters.
items.id integer
The unique Marco identifier for the public holiday.
items.start_date string
The start date of the public holiday, formatted as YYYY-MM-DD.
Example: 2023-12-31
items.end_date string
The end date of the public holiday, formatted as YYYY-MM-DD.
items.country integer
The unique Marco identifier for the country associated to the public holiday.
items.created_at string
Unix timestamp for the public holiday's creation date.
items.updated_at string
Unix timestamp for the public holiday's update date.
items.deleted_at string
Unix timestamp for the public holiday's deletion date.
items.last_modified_by integer
The unique Marco identifier for the user who last modified the public holiday.
items.dictionary array[object]
Contains the public holiday name and its corresponding notes in different languages.
dictionary.key integer
The type of data.
Valid values: data, notes "data" stores the public holiday name, while "notes" stores the public holiday notes.
dictionary.lang integer
The language that the data or notes are stored in.
Example: EN
dictionary.value integer
The field value for the data or notes.
Example: National Day
{public_holiday}.itemsReceived integer
The number of public holidays returned in the request.
{public_holiday}.curPage integer
The current page number.
{public_holiday}.nextPage integer
The following page number.
{public_holiday}.prevPage integer
The previous page number.
{public_holiday}.itemsTotal integer
The total number of public holidays in the response. This number should be the same as itemsReceived.
{public_holiday}.pageTotal integer
The total number of pages.