API reference/Catalog

Get selling calendar

Try it

Read a month's occasions with source and verification facts, editorial posture and dates for the requested year.

GET/api/v1/calendar

Authentication

Send your workspace key as xi-api-key or Authorization: Bearer.

catalog:readread

Parameters

Named placeholders belong in the path. Other arguments use query parameters.

monthRequired: integerRange: 1 to 12
yearRequired: integerRange: 2020 to 2100

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "month": 1,
  "year": 2020
}

Input schema

{
  "type": "object",
  "properties": {
    "month": {
      "type": "integer",
      "minimum": 1,
      "maximum": 12
    },
    "year": {
      "type": "integer",
      "minimum": 2020,
      "maximum": 2100
    }
  },
  "required": [
    "month",
    "year"
  ],
  "additionalProperties": false
}

Response schema

{
  "type": "object",
  "properties": {
    "month": {
      "type": "number"
    },
    "year": {
      "type": "number"
    },
    "occasions": {
      "type": "array",
      "items": {
        "type": "object",
        "propertyNames": {
          "type": "string"
        },
        "additionalProperties": {}
      }
    }
  },
  "required": [
    "month",
    "year",
    "occasions"
  ],
  "additionalProperties": false
}