GET
/
events
curl --request GET \
  --url https://api.smokeball.com/events \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "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": "<string>"
      },
      "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
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  }
}

Authorizations

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

Query Parameters

​
Offset
integer
Required range: 0 <= x <= 2147483647
​
Limit
integer
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

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

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 list of Event objects.

The response is of type object.