Sign in
latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

Events

Retrieve a single Event

Retrieves a single Event by its ID.

get/v2/event/{id}

Path parameters

idstring required
Example:EVT-Dxgp7NRjo6kXb5eG

The event ID (prefix EVT-).

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

The requested Event.

idstring

The ID of the event (prefix EVT-).

status'Done' | 'Open'

The status of the event.

titlestring

The title of the event.

descriptionstring

The description of the event.

startstring

The time & date when the event starts.

endstring

The time & date when the event ends.

isAllDayboolean

Whether the event is an all-day event.

techIdsstring[]

Array of tech IDs assigned to the event (prefix USR-).

isDeletedboolean

Whether the event is deleted.

updatedAtstring

The date and time the event was updated.

createdAtstring

The date and time the event was created.

attachmentsstring[]

Array of attachments.

Example response

{
  "id": "EVT-Dxgp7NRjo6kXb5eG",
  "title": "Doctor appointment",
  "description": "Doctor appointment with Dr. Smith",
  "start": "2024-07-25 09:00:00",
  "end": "2024-07-25 11:00:00",
  "techIds": [
    "USR-83510a9930f203f4",
    "USR-a4f86bf1deefec12",
    "USR-d59dbcd34aa19dce"
  ],
  "updatedAt": "2024-07-25 09:00:00",
  "createdAt": "2024-07-25 09:00:00",
  "attachments": [
    {
      "name": "example",
      "type": "jpg",
      "filePath": "https://example.com/example.jpg"
    }
  ]
}