List audit events

This API returns a list of all the audit log events that match the given filters.

Note: Not every single change in the system is audited. Currently the audited entities include:

ObjectActionNotes
customerform create/update/delete
customerapi create/update/delete
customercsv import
registerform create/update/delete
outletform create/update/delete
csv importinitTracks CSV import requests and includes data about the import type (customer, product) and the CSV file line count.
product*create/update/deleteAll actions on products.
securityterms_accepted, signin, signout, change_email, change_password, reset_password_confirm, user_switching_succes, user_switching_denied, new_personal_token, update_personal_token, delete_personal_tokenss, issue_oauth_token
vend_consignmentinsert/updateReceiving, creating and editing purchase orders as well as inventory counts.
vend_consignment_productinsert/updateChanges to the products in a purchase order. Such as creating purchase orders.
timeclockclockin/clockoutClock event where a user either clocked in or clocked out.

Filters

  • The from and to filters require a full isoformat date, for example ?from=2020-02-03T00:00:00&to=2020-02-05T23:59:59.

🔒 Requires: audit:read scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length ≤ 100

The size for a single page of results. By default 100 events will be returned.

string
length ≤ 0

The number of objects to skip.

string

The lower limit for the occurred_at attribute. to be included in the response. The date and time from needs to be in isoformat.

string

The upper limit for the occurred_at attribute. to be included in the response. The date and time from needs to be in isoformat.

string

The sorting order for the results. Sorting is done by the occurred_at parameter. The default order is descending.

string

The id of the user to filter the events by.

string

The type of the events to be filtered for the response.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
Insert of product example
application/json