Skip to main content
GET
/
events
/
{eventId}
Get an event
curl --request GET \
  --url https://api.smokeball.com/events/{eventId} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "matter": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "attendees": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "<string>"
    }
  ],
  "externalAttendees": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "<string>"
    }
  ],
  "eventType": 0,
  "subject": "Subject",
  "description": "Description",
  "location": "Location",
  "allDay": false,
  "nonBillable": false,
  "startTime": "2000-01-01T20:00:00",
  "endTime": "2000-01-01T20:00:00",
  "timeZone": "Australia/Sydney",
  "lastUpdated": "2000-01-01T20:00:00",
  "additionalData": {},
  "isDeleted": false
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
eventId
string<uuid>
required

Response

When request is successful. Returns a Event object.

​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
id
string | null

Unique identifier of the event.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

​
matter
object

Hypermedia link of the associated matter.

​
attendees
object[] | null

Hypermedia link of all the attendees.

​
externalAttendees
object[] | null

Hypermedia link of all the contacts of the external or third party attendees.

​
eventType
enum<integer>

The type of the event.

Possible values: Non Recurring Event = 0, Recurring Pattern Series = 1, Single Recurring Occurrence = 2, Modified Recurring Occurrence = 3, Deleted Recurring Occurrence = 4

Available options:
0,
1,
2,
3,
4
Example:

0

​
subject
string | null

Subject of event.

Example:

"Subject"

​
description
string | null

Description of event.

Example:

"Description"

​
location
string | null

Location of event.

Example:

"Location"

​
allDay
boolean

Whether or not the event is all day.

Example:

false

​
nonBillable
boolean

Whether or not the event is billable. Note events with a duration greater than 12 hours automatically become non-billable.

Example:

false

​
startTime
string<date-time>

Start date and time of the event. Supported date format is ISO YYYY-MM-DDThh:mm:ss. Note: date and time will correlate with the time zone provided.

Example:

"2000-01-01T20:00:00"

​
endTime
string<date-time>

End date and time of the event. Supported date format is ISO YYYY-MM-DDThh:mm:ss. Note: date and time will correlate with the time zone provided.

Example:

"2000-01-01T20:00:00"

​
timeZone
string | null

Time zone of the event for determining the start time and end time. Time zones will be in the IANA time zone format.

Example:

"Australia/Sydney"

​
lastUpdated
string<date-time>

The last date and time the event was updated. Supported date format is ISO YYYY-MM-DDThh:mm:ss.

Example:

"2000-01-01T20:00:00"

​
additionalData
object | null

Any additional data provided for the event.

​
isDeleted
boolean

Whether the event has been deleted.

Example:

false