Skip to main content
POST
List calendars

Restrictions

Usage

  • Without kind, personal calendars are returned. region.official.holiday and exchange.holiday return the shared calendars (public holidays, and stock-exchange trading days whose timezone is the exchange’s), filtered to the caller’s locale unless no_locale is true; use a holiday cal_id in extra_cal_ids, and an exchange cal_id directly in a rule.
  • The list is not paginated; total equals the number of items.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Calendar list request. kind filters by calendar kind; no_locale disables locale filtering for public holiday calendars.

kind
enum<string>

Calendar kind filter; defaults to personal when empty. region.official.holiday queries public regional holiday calendars (filtered by the caller's locale); exchange.holiday queries the shared stock-exchange calendars, whose cal_id a rule may read directly; personal queries account-created calendars.

Available options:
region.official.holiday,
exchange.holiday,
personal
no_locale
boolean

Disable locale filtering when listing public-holiday calendars.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Calendar list response.