Skip to main content
cURL
Cost: 1 API credit per page.
Returns one object per shop, with its holidays. Etsy keeps holiday settings for shops in the US and Canada only. Covers every connected shop in the workspace unless shop_id narrows it. A shop outside the workspace answers 404. Needs the workspace:read scope. is_working is null when Etsy gave no answer for that holiday.
A shop whose holiday settings Alura has never fetched from Etsy lists none, and summary.notices names it with settings_not_fetched. That means unknown, not “no holidays”.
summary.freshness gives each shop’s fetch time. To change a holiday, use Update holiday settings with its id. See Pagination for paging.

Authorizations

Authorization
string
header
required

An API key: Authorization: Bearer alura_sk_....

Query Parameters

shop_id
string[]

Only these connected shops, comma-separated; default every connected shop of the workspace. A shop outside the workspace is 404.

limit
integer

Page size: default 25, at most 100.

Required range: 1 <= x <= 100
cursor
string

The next_cursor of the previous page. Bound to the query, the workspace and the key.

fields
string

Comma-separated dotted paths to return; id, object and as_of always come back.

Response

OK

object
string
required
Allowed value: "list"
data
object[]
required
has_more
boolean
required
next_cursor
string | null
required
total
object
required
summary
object
required