SMsmokeball
Events

Get events

Returns a list of events.

get/events

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/events
  • Auth
    API key in header x-api-key and API key in header Authorization

Query parameters

Offsetinteger
Limitinteger
UpdatedSincestring
Example:2000-01-01T20:00:00 OR 630823536000000000

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.

MatterIdstring

Filter by events assigned to a specific MatterId.

ExcludeDeletedEventsboolean

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

Fromstring date-time
Example:2000-01-01T20:00:00

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.

Tostring date-time
Example:2000-01-01T20:00:00

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.

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
offsetinteger nullable
limitinteger nullable
sizeinteger

Example response

{
  "value": [
    {
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "subject": "Subject",
      "description": "Description",
      "location": "Location",
      "startTime": "2000-01-01T20:00:00",
      "endTime": "2000-01-01T20:00:00",
      "timeZone": "Australia/Sydney",
      "lastUpdated": "2000-01-01T20:00:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 15 revisions of this API.