Skip to main content
GET
List activity log entries for a subject

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Query Parameters

subjectType
enum<string>
required

Type of subject record whose history is being requested

Available options:
sales_order,
fulfillment_order,
shipment
subjectId
integer
required

ID of the subject record

Required range: x >= 1
userType
enum<string> | null

Filter by actor kind — user (human-initiated) or system (automated)

Available options:
user,
system
dateSort
enum<string> | null

Shortcut to override sort direction on created_at. When set, takes precedence over sortField / sortDirection.

Available options:
asc,
desc
includeLogName
string | null

Return only entries with this log_name (e.g. automation)

excludeLogNames
string[] | null

Exclude entries whose log_name is in this list. Ignored when includeLogName is set.

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:25

Results per page (max 100)

Required range: 1 <= x <= 100
sortField
string | null
default:created_at

Field to sort by (default created_at; overridden when dateSort is provided)

sortDirection
enum<string> | null
default:desc

Sort direction

Available options:
asc,
desc

Response

Paginated list of activity-log entries

data
object[]
meta
object