/events/{eventId} (GET)

Allows you to get information about a calendar event.

API Request Details

URL

GET/api/v1/calendar/events/{eventId}

Request Type

GET

Request Body

not required

Sample Request

https://<TENANT_URL>/api/v1/calendar/events/exampleEventId

Successful Sample Response

HTTP Status Code

Response Body

200

 
{
    “event”: {
        “id”:”exampleEventId”,
        “name”:”exampleEventName”,
        “description”: “exampleEventDescription”,
        “utcStartDate”: <UTCTimestamp in ISO 8601 format>,
        “utcEndDate”: <UTCTimestamp in ISO 8601 format>,
        “status”: “inProgress”,
        “progress”: 50
    }
}

Error Responses

Response Body

{
    error: {
        code: <String>,
        message: <String>,
        details: <Array>
    }
}

Possible HTTP Error Codes

HTTP Status Code

Returns

400

Bad Request

401

Unauthorized

404

Not Found

429

Too Many Requests

500

Server Error / Exception