GET https://www.appointment.one/api/v1/calendar

The calendar get request is used to obtain a list of calendars connected to the authenticated account.

Parameters

none

Response Codes

Expect the following http respond codes:

• 200 - Success
• 401 - Authentication failure. Occurs if the Authentication header is misused, if the API key has been revoked, or if the user/account is no longer active on Appointment.one

Response Values

• count - Number of elements returned in this response
• total_count - Total number of matching elements
• calendars - Object containing list of all returned matching appointments
  • id - Appointment unique ID
  • type - Calendar type, one of Google Apps, Office 365, or Exchange
  • default - Whether this is the default calendar associated with the user account
  • state - Calendar state, one of ok or access_error
  • date_added - Unix timestamp showing date the calendar was added

Example Response

Returns a json object with the following makeup.

{
  "calendars": [
    {
      "id": "test1@example.com",
      "type": "Google Apps",
      "default": true,
      "state": "ok",
      "date_added": "1484278504",
      "links": [
        {
          "rel": "self",
          "href": "/api/v1/calendar/test1@example.com",
          "verbs": [
            "GET",
            "DELETE"
          ]
        }
      ]
    },
    <...snip...>
  ],
  "count": 2,
  "total_count": 2,
  "links": [
    {
      "rel": "self",
      "href": "/api/v1/calendar",
      "verbs": [
        "GET"
      ]
    }
  ]
}

Examples

curl

> curl -vk \
       -H 'Content-Type: application/json' \
       -H 'Authorization: API_KEY_HERE' \
       -X GET 'https://www.appointment.one/api/v1/calendar'

python

>>> import requests

>>> r = requests.get('https://www.appointment.one/api/v1/calendar', 
                    headers= {'Authorization': 'API_KEY_HERE'})