Articles in this section

Audit API endpoints

download.svg​​ Download Postman collection

Understand and manage your audit logs

GET /v1/audit – Get all account audit information.

Get all audit information for your account. You can use query parameters to filter your audit logs by: resourceType, resourceId, _byUserId, source, action, to, and from.

Method

GET

Relative URI

/v1/audit

Query params

The following query params are available:

  • resourceTypestring

    • accesstoken

    • agent

    • api

    • asynchelper

    • connection

    • ediprofile

    • environment

    • export

    • filedefinition

    • flow

    • iclient

    • import

    • integration

    • lookupcache

    • notification

    • revision

    • script

    • ssoclient

    • stack

    • user

  • _resourceId (can be specified when also specifying a resourceType) – string

  • _byUserIdstring

  • sourcestring

    • api

    • connector

    • script

    • sso

    • stack

    • system

    • ui

  • actionstring

    • create

    • delete

    • purge

    • restore

    • signin

    • signout

    • update

    • view

  • todate

    Format: YYYY-MM-DDTHH:mm:ss.SSS[Z]

  • fromdate

    Format: YYYY-MM-DDTHH:mm:ss.SSS[Z]

Delta examples

This endpoint allows delta exporting by passing in a to and from parameter.

This extracts data from November 7, 2023 to November 8, 2023.

/audit?from=2023-11-07T23:14:43.032Z&to=2023-11-08T23:14:43.032Z

This extracts data from November 7, 2023.

/audit?from=2023-11-07T23:14:43.032Z

This extracts data up to November 8, 2023.

/audit?to=2023-11-08T23:14:43.032Z

Response body structure

[
  {
    "_id": "680••••••••••223",
    "resourceType": "flow",
    "_resourceId": "680••••••••203",
    "source": "api",
    "fieldChanges": [],
    "event": "create",
    "time": "2025-04-23T18:25:17.551Z",
    "byUser": {
      "_id": "65c•••••••••••••647",
      "name": "John Doe",
      "email": "email@domain.com"
    }
  }
]