Skip to main content
GET
Get a fiscal calendar and its fiscal year's start month
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/workflows/getFiscalCalendar?name=<slug> returns one deployment-wide fiscal calendar.

Authentication

External App credential or platform API key. Requires permission workflows:read. name must start with a lowercase letter and then contain only lowercase letters, digits, or underscores. A missing or invalid name returns 400; an unknown name returns 404. The response contains name, nullable label and description, fyStartMonth, createdAt, and updatedAt. Row ids and creator or updater identities are never returned. createFiscalCalendar, updateFiscalCalendar and deleteFiscalCalendar change them under workflows:manage.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

calendarName
string
required
Pattern: ^[a-z][a-z0-9_]*$

Response

The fiscal calendar

data
object
required

A fiscal-year calendar used by fiscalPeriod() expressions and derived launch inputs. Creating, changing or removing one needs workflows:manage at the platform scope.

meta
object
required