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

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

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 appointment cannot be found

Response Values

• id - Appointment unique ID
• attendees - Email addresses of everyone who was invited to the meeting. This includes the requester
• subject - Meeting subject
• requester_name - Name of the person who requested the meeting
• requester_email - Email of the person who requested the meeting
• time_start - Unix timestamp showing date the appointment is scheduled to start
• date_added - Unix timestamp showing date the appointment was created
• duration_mins - Meeting duration, in minutes
• is_cancelled - Bool indicated whether meeting has been cancelled

Example Response

Returns a json object with the following makeup.

{
  "id": "96e2a34f5eede44e2e962da8eb439dbf",
  "attendees": [
    "test2@example.com"
  ],
  "subject": "Test",
  "requester_name": "John Smith",
  "requester_email": "test1@example.com",
  "time_start": "1489680000",
  "duration_mins": "90",
  "date_added": "1489588974",
  "is_cancelled": true,
  "links": [
    {
      "rel": "self",
      "href": "/api/v1/appointment/96e2a34f5eede44e2e962da8eb439dbf",
      "verbs": [
        "GET",
        "DELETE"
      ]
    },
    {
      "rel": "event",
      "href": "/api/v1/event/15min",
      "verbs": [
        "GET",
        "DELETE"
      ]
    }
  ]
}

Examples

curl

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

python

>>> import requests

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