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": "27b23c27-0ab2-44e0-88ea-a24a26b7ee8f",
      "object": "event",
      "data": {
        "object": {
          "id": "ec933aef-533b-4993-b9f0-1d54d20f009f",
          "object": "purchase",
          "live_mode": true,
          "quantity": 1,
          "revoked": false,
          "revoked_at": null,
          "revoke_at": null,
          "customer": "879f23a4-0876-4497-8969-8ffd41d8f40a",
          "initial_order": "faa114d3-2565-41c3-a871-4c561cb55194",
          "license": null,
          "price": "c045780e-597f-4ee9-8187-68a0f1b35db0",
          "product": "85acf1c4-87b3-4ac7-8f18-ba60f9d945f9",
          "subscription": null,
          "variant": null,
          "review": null,
          "created_at": 1780925423,
          "updated_at": 1780925423
        }
      },
      "type": "purchase.created",
      "account": "8d23fddd-3f5a-4570-a6a7-1e251478d392",
      "created_at": 1780925423
    },
    {
      "id": "ab5f27fc-2201-49f6-9bb3-d516bd062146",
      "object": "event",
      "data": {
        "object": {
          "id": "faa114d3-2565-41c3-a871-4c561cb55194",
          "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/faa114d3-2565-41c3-a871-4c561cb55194",
          "statement_url": "http://app.example.com/statements/orders/faa114d3-2565-41c3-a871-4c561cb55194",
          "status": "paid",
          "checkout": "df2bcb1c-8f23-4317-a04e-654ad0106fc3",
          "created_at": 1780925422,
          "updated_at": 1780925422
        }
      },
      "type": "order.paid",
      "account": "8d23fddd-3f5a-4570-a6a7-1e251478d392",
      "created_at": 1780925422
    },
    {
      "id": "c968009d-c994-4280-9a4a-047d72561d19",
      "object": "event",
      "data": {
        "object": {
          "id": "649976ec-d649-41d3-95b4-dae887878996",
          "object": "purchase",
          "live_mode": true,
          "quantity": 1,
          "revoked": false,
          "revoked_at": null,
          "revoke_at": null,
          "customer": "879f23a4-0876-4497-8969-8ffd41d8f40a",
          "initial_order": "faa114d3-2565-41c3-a871-4c561cb55194",
          "license": null,
          "price": "c045780e-597f-4ee9-8187-68a0f1b35db0",
          "product": "85acf1c4-87b3-4ac7-8f18-ba60f9d945f9",
          "subscription": null,
          "variant": null,
          "review": null,
          "created_at": 1780925422,
          "updated_at": 1780925422
        }
      },
      "type": "purchase.created",
      "account": "8d23fddd-3f5a-4570-a6a7-1e251478d392",
      "created_at": 1780925422
    },
    {
      "id": "859855ea-b331-482c-bfb4-cabe3c2fb5bb",
      "object": "event",
      "data": {
        "object": {
          "id": "faa114d3-2565-41c3-a871-4c561cb55194",
          "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/faa114d3-2565-41c3-a871-4c561cb55194",
          "statement_url": "http://app.example.com/statements/orders/faa114d3-2565-41c3-a871-4c561cb55194",
          "status": "paid",
          "checkout": "df2bcb1c-8f23-4317-a04e-654ad0106fc3",
          "created_at": 1780925422,
          "updated_at": 1780925422
        }
      },
      "type": "order.made_processing",
      "account": "8d23fddd-3f5a-4570-a6a7-1e251478d392",
      "created_at": 1780925422
    },
    {
      "id": "ac0d9d9b-41d3-4b1b-a653-8bfabd282c7a",
      "object": "event",
      "data": {
        "object": {
          "id": "faa114d3-2565-41c3-a871-4c561cb55194",
          "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/faa114d3-2565-41c3-a871-4c561cb55194",
          "statement_url": "http://app.example.com/statements/orders/faa114d3-2565-41c3-a871-4c561cb55194",
          "status": "paid",
          "checkout": "df2bcb1c-8f23-4317-a04e-654ad0106fc3",
          "created_at": 1780925422,
          "updated_at": 1780925422
        }
      },
      "type": "order.created",
      "account": "8d23fddd-3f5a-4570-a6a7-1e251478d392",
      "created_at": 1780925422
    },
    {
      "id": "d38a3598-5876-4c7a-b9ce-26eba2c5486f",
      "object": "event",
      "data": {
        "object": {
          "id": "85acf1c4-87b3-4ac7-8f18-ba60f9d945f9",
          "object": "product",
          "allow_out_of_stock_purchases": false,
          "archived": false,
          "archived_at": null,
          "auto_fulfill_enabled": false,
          "available_stock": -1,
          "average_stars": "0.0",
          "bundle": false,
          "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": 1780925420,
          "discarded_at": null,
          "created_at": 1780925421,
          "updated_at": 1780925421
        }
      },
      "type": "product.stock_adjusted",
      "account": "8d23fddd-3f5a-4570-a6a7-1e251478d392",
      "created_at": 1780925421
    }
  ]
}

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.