Calendar Detail

GET /api/calendar/detail

Api key

Returns the detail of a calendar event

Query parameters

id integer Required

appointmentID

Responses

• default

Get user
Hide response attributes Show response attributes object
- security string
- categoryID integer
- permissions object
  
  Hide permissions attributes Show permissions attributes
  
  view boolean
  
  edit boolean
  
  admin boolean
  
  delete boolean
- appointmentType string
- createdBy integer
- endDate string(date-time)
- requireRegistration boolean
- createdDate string(date-time)
- startDate string(date-time)
- companyID integer
- privateDocuments boolean
- id integer
- name string
- teamID integer
- postCode string
- description string
- address string
- organiserID integer

GET /api/calendar/detail

curl \
 -X GET http://api.example.com/api/calendar/detail?id=42 \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (default)

{
  "security": "public",
  "categoryID": 42,
  "permissions": {
    "view": true,
    "edit": false,
    "admin": false,
    "delete": false
  },
  "appointmentType": "string",
  "createdBy": 42,
  "endDate": "2023-05-04T09:42:00+00:00",
  "requireRegistration": true,
  "createdDate": "2023-05-04T09:42:00+00:00",
  "startDate": "2023-05-04T09:42:00+00:00",
  "companyID": 42,
  "privateDocuments": true,
  "id": 42,
  "name": "string",
  "teamID": 42,
  "postCode": "string",
  "description": "string",
  "address": "string",
  "organiserID": 42
}