Get an event

Retrieves a specified event.

GET /events/{eventId}

Get an event

cURL

curl --request GET \
  --url https://api.smokeball.com/events/{eventId} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.smokeball.com/events/{eventId}"

headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>', Authorization: '<api-key>'}};

fetch('https://api.smokeball.com/events/{eventId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/events/{eventId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/events/{eventId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.smokeball.com/events/{eventId}")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/events/{eventId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "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": "GET"
  },
  "attendees": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET"
    }
  ],
  "externalAttendees": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET"
    }
  ],
  "eventType": "0",
  "type": "Normal",
  "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
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

eventId · string<uuid> · required

Response

200

application/json

When request is successful. Returns an 'Event' object.

href · string | null

relation · string | null

method · string | null · default: GET

self · object | null

Show child attributes

id · string | null

Unique identifier of the event.

Example:

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

matter · object | null

Hypermedia link of the associated matter.

Show child attributes

attendees · object[] | null

Hypermedia link of all the attendees.

Show child attributes

externalAttendees · object[] | null

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

Show child attributes

eventType · enum<string> · deprecated

Deprecated. Use type instead.

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: Normal, Pattern, Occurrence, ChangedOccurrence, DeletedOccurrence

Example:

"0"

type · enum<string>

The type of the event.

Possible values: Normal, Pattern, Occurrence, ChangedOccurrence, DeletedOccurrence

Available options: Normal, Pattern, Occurrence, ChangedOccurrence, DeletedOccurrence

Example:

"Normal"

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.

Show child attributes

isDeleted · boolean

Whether the event has been deleted.

Example:

false