GET https://www.appointment.one/api/v1/event/EVENT_ID

The event details get request is used to obtain details associated with a specific event.

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
• 404 - Specified event cannot be found

Response Values

The following values define the event itself:

• id - Event unique ID
• name - User friendly name
• status - Event status, one of active, disabled, or deleted
• visibility - Event visibility, one of public or unlisted
• url - URL where event can be accessed
• description - Publicly visible Event description
• bio - Customizable content visible to guests when scheduling an appointment through this event
• free_busy_calendars - Array of calendars which are sourced to free/busy information when determining availability
• date_added - Unix timestamp showing date the event was created

The following values are all replicated into new appointments generated from this event:

• invitation_title - Title (or subject) that will be used for appointment invites cloned through this event
• invitation_body - Body that will be used for appointment invites cloned through this event
• location - Location field to be clone to created appointments
• duration - Event duration, in minutes
• attendees - Email addresses of everyone who should always be invited to appointments cloned through this event

Example Response

Returns a json object with the following makeup.

{
  "id": "30min",
  "name": "30 minute appointment",
  "status": "active",
  "date_added": "1484278495",
  "visibility": "public",
  "location": "Bridge 800-555-5555",
  "bio": "<p><br></p>",
  "url": "30min",
  "attendees": "[]",
  "invitation_title": null,
  "invitation_body": null,
  "description": "lorem ipsum.",
  "duration": "30",
  "free_busy_calendars": [
    "test2@example.com"
  ],
  "links": [
    {
      "rel": "self",
      "href": "/api/v1/event/30min",
      "verbs": [
        "GET",
        "DELETE"
      ]
    },
    {
      "rel": "public",
      "href": "https://www.appointment.one/test/30min",
      "verbs": [
        "GET"
      ]
    }
  ]
}

Examples

curl

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

python

>>> import requests

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