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": "091a8779-537b-455c-8979-fb8d0bc1a116",
      "object": "event",
      "data": {
        "object": {
          "id": "56005cfd-710a-49a4-96bf-c1e8b07984c2",
          "object": "purchase",
          "live_mode": true,
          "quantity": 1,
          "revoked": false,
          "revoked_at": null,
          "revoke_at": null,
          "customer": "7d56554f-bc04-4661-b6bf-7f441aee2163",
          "initial_order": "53027f12-a748-467c-9381-b0890703423c",
          "license": null,
          "price": "8a7909fe-7930-49b1-96cf-d2eb2a5fbcb4",
          "product": "5bb6ebc1-1104-4148-9ea0-01197170f626",
          "subscription": null,
          "variant": null,
          "review": null,
          "created_at": 1773903545,
          "updated_at": 1773903545
        }
      },
      "type": "purchase.created",
      "account": "eadf8cab-28f7-4ff9-bdba-27062f3f0191",
      "created_at": 1773903545
    },
    {
      "id": "a3a84d31-b0cc-45b7-ba48-d62c31642772",
      "object": "event",
      "data": {
        "object": {
          "id": "53027f12-a748-467c-9381-b0890703423c",
          "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/53027f12-a748-467c-9381-b0890703423c",
          "statement_url": "http://app.example.com/statements/orders/53027f12-a748-467c-9381-b0890703423c",
          "status": "paid",
          "checkout": "137193e5-ac1a-45bf-b273-c40f5bc91183",
          "created_at": 1773903544,
          "updated_at": 1773903544
        }
      },
      "type": "order.paid",
      "account": "eadf8cab-28f7-4ff9-bdba-27062f3f0191",
      "created_at": 1773903544
    },
    {
      "id": "ad9d1e40-7f0a-418b-abd6-b8a854fc5e04",
      "object": "event",
      "data": {
        "object": {
          "id": "1208169c-70ef-46c3-8cc7-506378abef0b",
          "object": "purchase",
          "live_mode": true,
          "quantity": 1,
          "revoked": false,
          "revoked_at": null,
          "revoke_at": null,
          "customer": "7d56554f-bc04-4661-b6bf-7f441aee2163",
          "initial_order": "53027f12-a748-467c-9381-b0890703423c",
          "license": null,
          "price": "8a7909fe-7930-49b1-96cf-d2eb2a5fbcb4",
          "product": "5bb6ebc1-1104-4148-9ea0-01197170f626",
          "subscription": null,
          "variant": null,
          "review": null,
          "created_at": 1773903544,
          "updated_at": 1773903544
        }
      },
      "type": "purchase.created",
      "account": "eadf8cab-28f7-4ff9-bdba-27062f3f0191",
      "created_at": 1773903544
    },
    {
      "id": "019b2ea2-f036-4207-a264-e493d8a0fdd4",
      "object": "event",
      "data": {
        "object": {
          "id": "53027f12-a748-467c-9381-b0890703423c",
          "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/53027f12-a748-467c-9381-b0890703423c",
          "statement_url": "http://app.example.com/statements/orders/53027f12-a748-467c-9381-b0890703423c",
          "status": "paid",
          "checkout": "137193e5-ac1a-45bf-b273-c40f5bc91183",
          "created_at": 1773903544,
          "updated_at": 1773903544
        }
      },
      "type": "order.made_processing",
      "account": "eadf8cab-28f7-4ff9-bdba-27062f3f0191",
      "created_at": 1773903544
    },
    {
      "id": "09707b73-0c13-4f5f-bc64-620fba2527f5",
      "object": "event",
      "data": {
        "object": {
          "id": "53027f12-a748-467c-9381-b0890703423c",
          "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/53027f12-a748-467c-9381-b0890703423c",
          "statement_url": "http://app.example.com/statements/orders/53027f12-a748-467c-9381-b0890703423c",
          "status": "paid",
          "checkout": "137193e5-ac1a-45bf-b273-c40f5bc91183",
          "created_at": 1773903544,
          "updated_at": 1773903544
        }
      },
      "type": "order.created",
      "account": "eadf8cab-28f7-4ff9-bdba-27062f3f0191",
      "created_at": 1773903544
    },
    {
      "id": "ea69c4c7-67ca-468b-81d7-122af5c454f6",
      "object": "event",
      "data": {
        "object": {
          "id": "5bb6ebc1-1104-4148-9ea0-01197170f626",
          "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": 1773903544,
          "discarded_at": null,
          "created_at": 1773903544,
          "updated_at": 1773903544
        }
      },
      "type": "product.stock_adjusted",
      "account": "eadf8cab-28f7-4ff9-bdba-27062f3f0191",
      "created_at": 1773903544
    }
  ]
}

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.