Skip to main content

List Audit Logs

GET 
/v1/audit_logs

List audit log entries recorded under your acquirer and its merchants, newest first.

Required permission: audit_logs_read.

Request​

Query Parameters

    items integer

    Possible values: >= 1 and <= 100

    Number of items per page.

    performer_id uuid

    Filter by the acting user / API key UUID.

    performer_type string

    Possible values: [AcquirerUser, MerchantUser, StaffUser, ApiKey, AcquirerApiKey]

    performer_email string

    Filter by the acting user's email (partial match).

    subject_type string

    Filter by subject model (prefix match). See the Subjects endpoint for the values available to your principal.

    subject_id uuid
    organization_type string

    Possible values: [Acquirer, Merchant]

    organization_name string

    Filter by acquirer / merchant name (partial match).

    action_type string

    Possible values: [active, passive]

    action_name string

    Filter by controller action (prefix match), e.g. create.

    created_at[gte] date-time
    created_at[lte] date-time
    sort[field] string

    Possible values: [performer_type, subject_type, action_type, created_at]

    Default value: created_at

    sort[dir] string

    Possible values: [asc, desc]

    Default value: desc

Responses​

Paginated list of audit log entries.

Schema

    audit_logs

    object[]

    required

  • Array [

    • id uuidrequired

    A 36-character UUIDv7 identifier.

    performer_type string

    Possible values: [AcquirerUser, MerchantUser, StaffUser, ApiKey, AcquirerApiKey]

    performer

    object

    nullable

    Brief view of the acting user / API key (id, email when applicable).

    id uuid

    A 36-character UUIDv7 identifier.

    email stringnullable
    organization_type stringnullable

    Possible values: [Acquirer, Merchant, null]

    organization

    object

    nullable

    Brief view of the owning organization.

    id uuid

    A 36-character UUIDv7 identifier.

    name string
    merchant_id stringnullable
    subject_type stringnullable

    Model name of the resource acted upon.

    subject_id uuid

    A 36-character UUIDv7 identifier.

    login_session_id uuid

    A 36-character UUIDv7 identifier.

    action stringrequired

    Controller action name.

    action_type stringrequired

    Possible values: [active, passive]

    description string
    metadata object

    Request context — request_path, request_payload, user_agent, ip_info, and for active entries subject_changes (before / after values, sensitive fields filtered).

    created_at date-timerequired

    ISO 8601 UTC timestamp with time zone designator.

  • ]

    • meta

    object

    required

    Cursor-style pagination metadata. next_page and prev_page are null at the boundaries. Total counts are intentionally omitted for performance on large result sets (countless pagination).

    current_page integerrequired

    Possible values: >= 1

    next_page integernullablerequired
    prev_page integernullablerequired
Loading...
Last updated on