Get events

Returns a list of events.

GET /events

Get events

cURL

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

200

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "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
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  }
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Query Parameters

Offset · integer<int32>

Required range: 0 <= x <= 2147483647

Limit · integer<int32>

Required range: 1 <= x <= 500

UpdatedSince · string

Filter by events updated since a specified time. Supported date formats are ISO YYYY-MM-DDThh:mm:ss or .net ticks representation of the UTC datetime.

Example:

"2000-01-01T20:00:00 OR 630823536000000000"

MatterId · string

Filter by events assigned to a specific MatterId.

ExcludeDeletedEvents · boolean

Filter out any events that have been deleted, default: false

Example:

false

From · string<date-time>

Filter events from a specified UTC date and time. Defaults to the UTC datetime of the request. Dates should be provided in ISO format YYYY-MM-DDThh:mm:ss.

Example:

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

To · string<date-time>

Filter events to a specified UTC date and time. If no datetime is specified all future events will be returned. Dates should be provided in ISO format YYYY-MM-DDThh:mm:ss.

Example:

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

Response

200 - application/json

When request is successful. Returns a paged collection of 'Event' objects.

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET

self · object | null

Show child attributes

value · object[] | null

Show child attributes

offset · integer<int32> | null

limit · integer<int32> | null

size · integer<int64>

first · object | null

Show child attributes

previous · object | null

Show child attributes

next · object | null

Show child attributes

last · object | null

Show child attributes