v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Event

Retrieves the collection of Event resources.

get/events

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Event collection

idstring

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

the unique identifier of the source 3rd party integration

titlestring nullable

title of the event

hoststring nullable

host of the event

eventContactstring nullable

related customers or leads to the event

eventStartTimestring date-time nullable

planned start time of the event

eventEndTimestring date-time nullable

planned end time of the event

locationstring nullable

location of the event

descriptionstring nullable

details about the event

createdstring date-time nullable

when the event objects are created

modifiedstring date-time nullable

when the event objects are modified

statusstring nullable

The status of the event e.g. "SCHEDULED" e.g. "DONE"

typestring nullable

The type of event e.g. "CONTENT" e.g. "SOCIAL"

urlstring nullable

Public url for the event

[
  {
    "integration": "quickbooks"
  }
]