API reference/Catalog

Get monthly Best Of

Try it

Read the rolling Best Of ballot for one month; this is not the annual Contest Buddy ballot.

GET/api/v1/best-of/{month}

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

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "month": 1
}

Input schema

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

Response schema

{
  "type": "object",
  "properties": {
    "ballot": {
      "anyOf": [
        {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {}
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "ballot"
  ],
  "additionalProperties": false
}