Skip to main content
GET
/
v1
/
events
List
curl --request GET \
  --url https://{defaultHost}/v1/events \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 6,
    "limit": 20,
    "page": 1,
    "url": "/v1/events"
  },
  "data": [
    {
      "id": "5b48fb54-6596-4f2c-ac16-f3dd9430ec7d",
      "object": "event",
      "data": {
        "object": {
          "id": "ad228131-2934-4614-afd6-41ee69edb195",
          "object": "purchase",
          "live_mode": true,
          "quantity": 1,
          "revoked": false,
          "revoked_at": null,
          "revoke_at": null,
          "customer": "a41f3202-782c-43a6-8df3-002136938e71",
          "initial_order": "50c4f38f-fa93-47ae-8cad-ed6190d13a55",
          "license": null,
          "price": "273fafc5-f6bd-4838-8cd8-b2e2944bd602",
          "product": "12bc92a9-33dc-41dc-8132-89f27dd42620",
          "subscription": null,
          "variant": null,
          "review": null,
          "created_at": 1776176528,
          "updated_at": 1776176528
        }
      },
      "type": "purchase.created",
      "account": "914fc437-5002-428a-ab5a-0ab7d863705a",
      "created_at": 1776176528
    },
    {
      "id": "b2b8cb02-997b-4142-966a-bf3849d89b78",
      "object": "event",
      "data": {
        "object": {
          "id": "50c4f38f-fa93-47ae-8cad-ed6190d13a55",
          "object": "order",
          "fulfillment_status": "unfulfilled",
          "live_mode": true,
          "number": "0001",
          "order_type": "checkout",
          "return_status": "not_returned",
          "shipment_status": "unshippable",
          "portal_url": "http://app.example.com/portal_redirect/orders/50c4f38f-fa93-47ae-8cad-ed6190d13a55",
          "statement_url": "http://app.example.com/statements/orders/50c4f38f-fa93-47ae-8cad-ed6190d13a55",
          "status": "paid",
          "checkout": "f5ffc156-0911-4dda-83d0-996101f084b0",
          "created_at": 1776176528,
          "updated_at": 1776176528
        }
      },
      "type": "order.paid",
      "account": "914fc437-5002-428a-ab5a-0ab7d863705a",
      "created_at": 1776176528
    },
    {
      "id": "f643c7dc-f71b-4483-8281-31cc5100111e",
      "object": "event",
      "data": {
        "object": {
          "id": "29122f3b-031f-4c40-ae45-914a1803e3e5",
          "object": "purchase",
          "live_mode": true,
          "quantity": 1,
          "revoked": false,
          "revoked_at": null,
          "revoke_at": null,
          "customer": "a41f3202-782c-43a6-8df3-002136938e71",
          "initial_order": "50c4f38f-fa93-47ae-8cad-ed6190d13a55",
          "license": null,
          "price": "273fafc5-f6bd-4838-8cd8-b2e2944bd602",
          "product": "12bc92a9-33dc-41dc-8132-89f27dd42620",
          "subscription": null,
          "variant": null,
          "review": null,
          "created_at": 1776176528,
          "updated_at": 1776176528
        }
      },
      "type": "purchase.created",
      "account": "914fc437-5002-428a-ab5a-0ab7d863705a",
      "created_at": 1776176528
    },
    {
      "id": "b91aefa3-37d6-460f-9f9b-2078fae2ae49",
      "object": "event",
      "data": {
        "object": {
          "id": "50c4f38f-fa93-47ae-8cad-ed6190d13a55",
          "object": "order",
          "fulfillment_status": "unfulfilled",
          "live_mode": true,
          "number": "0001",
          "order_type": "checkout",
          "return_status": "not_returned",
          "shipment_status": "unshippable",
          "portal_url": "http://app.example.com/portal_redirect/orders/50c4f38f-fa93-47ae-8cad-ed6190d13a55",
          "statement_url": "http://app.example.com/statements/orders/50c4f38f-fa93-47ae-8cad-ed6190d13a55",
          "status": "paid",
          "checkout": "f5ffc156-0911-4dda-83d0-996101f084b0",
          "created_at": 1776176528,
          "updated_at": 1776176528
        }
      },
      "type": "order.made_processing",
      "account": "914fc437-5002-428a-ab5a-0ab7d863705a",
      "created_at": 1776176528
    },
    {
      "id": "000d2a87-6533-41e5-81eb-180bad67600d",
      "object": "event",
      "data": {
        "object": {
          "id": "50c4f38f-fa93-47ae-8cad-ed6190d13a55",
          "object": "order",
          "fulfillment_status": "unfulfilled",
          "live_mode": true,
          "number": "0001",
          "order_type": "checkout",
          "return_status": "not_returned",
          "shipment_status": "unshippable",
          "portal_url": "http://app.example.com/portal_redirect/orders/50c4f38f-fa93-47ae-8cad-ed6190d13a55",
          "statement_url": "http://app.example.com/statements/orders/50c4f38f-fa93-47ae-8cad-ed6190d13a55",
          "status": "paid",
          "checkout": "f5ffc156-0911-4dda-83d0-996101f084b0",
          "created_at": 1776176528,
          "updated_at": 1776176528
        }
      },
      "type": "order.created",
      "account": "914fc437-5002-428a-ab5a-0ab7d863705a",
      "created_at": 1776176528
    },
    {
      "id": "ee9e84c5-6297-4825-b0dd-b2fabcb4ffe4",
      "object": "event",
      "data": {
        "object": {
          "id": "12bc92a9-33dc-41dc-8132-89f27dd42620",
          "object": "product",
          "allow_out_of_stock_purchases": false,
          "archived": false,
          "archived_at": null,
          "auto_fulfill_enabled": false,
          "available_stock": -1,
          "average_stars": "0.0",
          "description": null,
          "dimensions": null,
          "held_stock": 1,
          "featured": false,
          "licensing_enabled": false,
          "license_activation_limit": null,
          "metadata": {},
          "purchase_limit": null,
          "metrics": {
            "currency": "usd",
            "max_price_amount": 2900,
            "min_price_amount": 2900,
            "prices_count": 1
          },
          "name": "Test Product",
          "recurring": false,
          "reviews_breakdown": {},
          "reviews_enabled": true,
          "shipping_enabled": false,
          "sku": null,
          "slug": "test-product",
          "solicit_reviews": true,
          "status": "draft",
          "stock": 0,
          "stock_enabled": false,
          "tax_enabled": false,
          "tax_category": "tangible",
          "weight": 0,
          "weight_unit": "lb",
          "commission_structure": null,
          "featured_product_media": null,
          "product_group": null,
          "current_release_download": null,
          "shipping_profile": null,
          "cataloged_at": 1776176527,
          "discarded_at": null,
          "created_at": 1776176527,
          "updated_at": 1776176527
        }
      },
      "type": "product.stock_adjusted",
      "account": "914fc437-5002-428a-ab5a-0ab7d863705a",
      "created_at": 1776176528
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
page
integer

The page of items you want returned.

​
record_ids[]
string[]

Only return objects that belong to the given records.

​
type[]
string[]

Only return events with the given type.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.