# Download custom calendar as JSON

**GET** `https://api.zoined.com/v2/download/calendar.json?limit=1000&offset=0&year=2018&period=season`

Endpoint: GET /v2/download/calendar.json
Security: bearerAuth

## Security:

  - `bearerAuth` (unknown)
    http bearer token

## Query parameters:

  - `limit` (number)
    How many entries to return

  - `offset` (number)
    Which offset to return data from

  - `year` (number)
    Returns calendar period data for given year(s) only

  - `period` (string)
    Returns calendar period data for given period type(s) only

## Response 200:

  - `200` (unknown)
    Request has been processed successfully.
**Headers**
- `Content-Type: application/json`

## Response 200 fields (application/json):

  - `period_key` (string, required)
    Period type identifier
    Example: season

  - `period_year` (number, required)
    Period year
    Example: 2018

  - `period_name` (string, required)
    Name of period
    Example: Autumn Season

  - `period_number` (number, required)
    period numeric id
    Example: 2

  - `start_date` (string, required)
    Start date of period
    Example: 2018-07-01

  - `end_date` (string, required)
    End date of period
    Example: 2018-12-31

## Response 400:

  - `400` (unknown)
    Invalid or malformed request.
**Headers**
- `Content-Type: application/json`

## Response 400 fields (application/json):

  - `status` (string, required)
    Status of the operation OK / Not OK
    Example: Not OK

  - `msg` (string, required)
    Message describing result of operation
    Example: Reason for error

## Response 401:

  - `401` (unknown)
    Missing or invalid authorization token in header
**Headers**
- `Content-Type: application/json`

## Response 401 fields (application/json):

  - `status` (string, required)
    Status of the operation OK / Not OK
    Example: Not OK

  - `msg` (string, required)
    Message describing result of operation
    Example: Unauthorized

## Response 500:

  - `500` (unknown)
    Internal error or exception
**Headers**
- `Content-Type: application/json`

## Response 500 fields (application/json):

  - `status` (string, required)
    Status of the operation OK / Not OK
    Example: Not OK

  - `msg` (string, required)
    Message describing result of operation
    Example: Reason for error

## Response 200 examples:

  - `response` (unknown)

## Response 400 examples:

  - `response` (unknown)

## Response 401 examples:

  - `response` (unknown)

## Response 500 examples:

  - `response` (unknown)