Skip to content
Crossmart Docs

Who changed what in the workspace, newest first

GET
/api/v1/workspaces/{workspaceId}/activity
curl --request GET \
  --url 'https://api.crossmart.io/api/v1/workspaces/example/activity?action=product_created&outcome=SUCCEEDED&direction=desc&limit=25&subjectType=product'

Includes operations that failed, such as an import that created nothing.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspaceId
required
string

Query Parameters

Section titled “Query Parameters”
action
string
Allowed values: product_created product_updated product_deleted products_bulk_updated products_bulk_deleted products_imported products_updated_by_import stock_imported channel_catalog_imported product_view_created product_view_deleted api_key_created api_key_revoked member_invited invitation_revoked member_joined member_role_changed member_removed member_left workspace_created workspace_renamed workspace_time_zone_changed custom_role_created custom_role_updated custom_role_deleted inventory_adjusted channel_connected channel_disconnected channel_connect_failed listing_published listing_updated listing_sync_failed listing_delisted listing_added listing_removed listing_override_updated channel_pricing_updated channel_selection_updated channel_listing_defaults_updated channel_policies_opted_in channel_default_policies_created listing_category_changed listing_item_specifics_changed channel_sync_requested listing_retry_requested stock_oversold content_generation_requested content_generated suggestion_approved suggestion_rejected suggestions_bulk_approved
outcome
string
Allowed values: SUCCEEDED FAILED

FAILED lists only what went wrong

direction
string
Allowed values: asc desc
cursor
string format: uuid

nextCursor from the previous page

page
number
>= 1

1-based page number, for tables with page numbers. It wins over cursor.

limit
number
default: 25 >= 1 <= 100
subjectType
string
Allowed values: product product_view import_job api_key member invitation workspace custom_role channel_connection
subjectId
string format: uuid

Events about this record, including bulk actions that touched it

actorUserId
string format: uuid

Only what this user did

actorApiKeyId
string format: uuid

Only what this API key did

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
action
required
string
Allowed values: product_created product_updated product_deleted products_bulk_updated products_bulk_deleted products_imported products_updated_by_import stock_imported channel_catalog_imported product_view_created product_view_deleted api_key_created api_key_revoked member_invited invitation_revoked member_joined member_role_changed member_removed member_left workspace_created workspace_renamed workspace_time_zone_changed custom_role_created custom_role_updated custom_role_deleted inventory_adjusted channel_connected channel_disconnected channel_connect_failed listing_published listing_updated listing_sync_failed listing_delisted listing_added listing_removed listing_override_updated channel_pricing_updated channel_selection_updated channel_listing_defaults_updated channel_policies_opted_in channel_default_policies_created listing_category_changed listing_item_specifics_changed channel_sync_requested listing_retry_requested stock_oversold content_generation_requested content_generated suggestion_approved suggestion_rejected suggestions_bulk_approved
outcome
required
string
Allowed values: SUCCEEDED FAILED
summary
required
string
actor
required
object
type
required
string
Allowed values: USER API_KEY SYSTEM
userId
required
string format: uuid
nullable
apiKeyId
required
string format: uuid
nullable
name
required

User or API key name; null for system actions and deleted users or keys

string
nullable
email
required

Set for users only

string
nullable
subject
required
object
type
required
string
Allowed values: product product_view import_job api_key member invitation workspace custom_role channel_connection
id
required
string format: uuid
nullable
label
required

The name when the event happened

string
nullable
itemCount
required

Items the action covered, such as products changed in bulk

number
nullable
failureReason
required

Why a failed action failed

string
nullable
createdAt
required
string format: date-time
nextCursor
required

Null on the last page

string
nullable
total
required

How many match in all, for page numbers

number

Example 

{
  "items": [
    {
      "action": "product_created",
      "outcome": "SUCCEEDED",
      "summary": "Updated product “Linen Shirt”",
      "actor": {
        "type": "USER"
      },
      "subject": {
        "type": "product"
      }
    }
  ]
}