activityLogs

Requires permission audit:activity_log:read.

Lists the organization's activity log, one page at a time, optionally filtered by person, record type, action, source and dates. Pages hold at most 100 entries. Some courier cost details are shown only to viewers who may ship sales orders. Requires permission to read the activity log.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ActivityLogs {
  activityLogs {
    page
    pageSize
    total
    items {
      id
      actorName
      createdAt
      action
      actorEmail
      actorId
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ActivityLogs {\n  activityLogs {\n    page\n    pageSize\n    total\n    items {\n      id\n      actorName\n      createdAt\n      action\n      actorEmail\n      actorId\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "activityLogs": {
      "page": 0,
      "pageSize": 0,
      "total": 0,
      "items": [
        {
          "id": "string",
          "actorName": "string",
          "createdAt": "2025-01-15T00:00:00Z",
          "action": "string",
          "actorEmail": "string",
          "actorId": "string"
        }
      ]
    }
  }
}

activityLogs(
  filter: ActivityLogFilterInput
  page: Int = 1
  pageSize: Int = 25
): ActivityLogsResponse!

Arguments

activityLogs.filter ● ActivityLogFilterInput input

Optional filters: search text, person, record type, action, source and a date range.

activityLogs.page ● Int scalar

The page number, starting at 1.

activityLogs.pageSize ● Int scalar

How many entries per page. Defaults to 25 and is capped at 100.

Type

ActivityLogsResponse object

A page of activity log events.