Skip to main content

Get Activity Log

GET 

/api/shipbob/:instance/activity-log

Paginated activity for the connection — instance-level configuration and connection changes plus activity for every order belonging to the instance. Ordered newest-first.

Required scope: integrations:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Filters: filter[event], filter[source], filter[batch_uuid], and filter[search] (matches the event name, the acting user's name, the description, and the properties payload).

Pagination: page, per_page (default 15).

Each entry also carries subject_label (e.g. ShipBob connection, ShipBob order SO-SB-1003), field_labels (changed-field key → plain name, e.g. integration_settings.fulfillment_cost_financial_line_type_id → Freight line type) and value_labels (field key → id → name for the freight line type and default nominal code). Sync bookkeeping (last_sync, last_webhook_received_at, billing.last_synced_at, billing.sync_resume, billing.resolver_version, billing.last_error*) is never logged and is stripped from older entries.

Authentication: Requires Bearer token.

Sync bookkeeping (details_last_updated on orders, sync timestamps on the connection) is never shown, and rows whose only change was bookkeeping are left out. Changes a ShipBob sync or webhook made carry properties.source = shipbob_sync and no causer (filter[source]=shipbob_sync).

Request​

Responses​

OK

Response Headers
    Content-Type