Last updated
Last updated
To list all events in your company environment you may use the company.event.find
endpoint with multiple filters and pagination. The required query attributes for this endpoint are tokenID
, companyID
and selection
, and we have several optional attributes for filtering and pagination.
Selection
query attributeThe selection
query attribute accepts the following values:
The selection
query attribute allows stacking (AND operation) by separating values with a pipe. Example: selection=my-events|next-events
. It also allows complex stacking for a certain key, like tags
. Example: selection=my-events|next-events|tags:29124,4255
.
We also have the following optional query attributes as filters:
You can also use query
and queryKey
instead of using the field name as the query attribute directly if you prefer.
To paginate you can use limit
and offset
query attributes and to get the total amount of events listed in your account (used to build pagination UI and calculate the amount of pages) you should send the paginated
query attribute with value 1
.
To order the events you can use the following query attributes: order
and orderOrientation
. The orderOrientation
attribute accepts ASC
(ascending) and DESC
(descending) as values
and the order
query attribute accepts the following values:
Here is an example of this API call:
To generate a spreadsheet report out of that API call, you can send the format
attribute with the value excel-daemon
. Excel spreadsheets takes a while to generate and they will show up in your Report center
, but you can also retrieve them using the download.find
endpoint.