GET /events

List all events for a particular customer. Events can be filtered by user, customer and event type. Events can be sorted by date.

Authorization: Requires API token.

Servers

Request headers

Name Type Required Description
host String No

Query parameters

Name Type Required Description
filter[created_at][gte] String No

Return events on and after a date and time in ISO 8601 format.

page[number] String No

Current page.

sort String No

The order in which to list the results by creation date.

filter[token_id] String No

Limit the returned events to a specific token.

filter[user_id] String No

Limit the results returned to a specific user.

page[size] String No

Number of records per page.

filter[created_at][lte] String No

Return events on and before a date and time in ISO 8601 format.

filter[customer_id] String No

Limit the results returned to a specific customer.

filter[event_type] String No

Limit the returned events to a specific event_type.

filter[created_at][gt] String No

Return events after a date and time in ISO 8601 format.

filter[created_at][lt] String No

Return events before a date and time in ISO 8601 format.

filter[created_at] String No

Limit the returned events to a specific time frame. Accepts sub-parameters: lt, lte, gt, gte (e.g., filter[created_at][gt]=2022-01-12).

filter[service_id] String No

Limit the results returned to a specific service.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.