Skip to main content
GET
/
v1
/
events
List
curl --request GET \
  --url https://{defaultHost}/v1/events \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://{defaultHost}/v1/events"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{defaultHost}/v1/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{defaultHost}/v1/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{defaultHost}/v1/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://{defaultHost}/v1/events")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{defaultHost}/v1/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "object": "list",
  "pagination": {
    "count": 6,
    "limit": 20,
    "page": 1,
    "url": "/v1/events"
  },
  "data": [
    {
      "id": "9a2d886d-2040-479e-91cb-f38427505dc4",
      "object": "event",
      "data": {
        "object": {
          "id": "df542365-95bc-4fd1-bb40-5bbdc8e27f45",
          "object": "purchase",
          "live_mode": true,
          "quantity": 1,
          "revoked": false,
          "revoked_at": null,
          "revoke_at": null,
          "customer": "df74a661-e183-4dd9-8d8a-8ce78d113cab",
          "initial_order": "98c85017-9016-4207-9925-de746d6ca0fe",
          "license": null,
          "price": "1433c75f-8c8b-48e0-9e7d-b418ffc189d9",
          "product": "1ed9600f-e85e-4899-9e0d-90db15b87a4e",
          "subscription": null,
          "variant": null,
          "review": null,
          "created_at": 1782485828,
          "updated_at": 1782485828
        }
      },
      "type": "purchase.created",
      "account": "c64c18d3-9fc0-4fb0-a85c-c939d9caf607",
      "created_at": 1782485828
    },
    {
      "id": "966893b2-7483-4d71-9e4c-b107d6a60e8a",
      "object": "event",
      "data": {
        "object": {
          "id": "98c85017-9016-4207-9925-de746d6ca0fe",
          "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/98c85017-9016-4207-9925-de746d6ca0fe",
          "statement_url": "http://app.example.com/statements/orders/98c85017-9016-4207-9925-de746d6ca0fe",
          "status": "paid",
          "checkout": "bed514a0-03c1-4e34-ba1b-c8c1a960dd62",
          "created_at": 1782485828,
          "updated_at": 1782485828
        }
      },
      "type": "order.paid",
      "account": "c64c18d3-9fc0-4fb0-a85c-c939d9caf607",
      "created_at": 1782485828
    },
    {
      "id": "d059fc5f-e575-4439-9628-c4b4c8083479",
      "object": "event",
      "data": {
        "object": {
          "id": "ee0ebee5-b4da-4eea-b381-6e63e9fea8a2",
          "object": "purchase",
          "live_mode": true,
          "quantity": 1,
          "revoked": false,
          "revoked_at": null,
          "revoke_at": null,
          "customer": "df74a661-e183-4dd9-8d8a-8ce78d113cab",
          "initial_order": "98c85017-9016-4207-9925-de746d6ca0fe",
          "license": null,
          "price": "1433c75f-8c8b-48e0-9e7d-b418ffc189d9",
          "product": "1ed9600f-e85e-4899-9e0d-90db15b87a4e",
          "subscription": null,
          "variant": null,
          "review": null,
          "created_at": 1782485828,
          "updated_at": 1782485828
        }
      },
      "type": "purchase.created",
      "account": "c64c18d3-9fc0-4fb0-a85c-c939d9caf607",
      "created_at": 1782485828
    },
    {
      "id": "30763461-7a5b-4e03-bf84-4f1306e27a36",
      "object": "event",
      "data": {
        "object": {
          "id": "98c85017-9016-4207-9925-de746d6ca0fe",
          "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/98c85017-9016-4207-9925-de746d6ca0fe",
          "statement_url": "http://app.example.com/statements/orders/98c85017-9016-4207-9925-de746d6ca0fe",
          "status": "paid",
          "checkout": "bed514a0-03c1-4e34-ba1b-c8c1a960dd62",
          "created_at": 1782485828,
          "updated_at": 1782485828
        }
      },
      "type": "order.made_processing",
      "account": "c64c18d3-9fc0-4fb0-a85c-c939d9caf607",
      "created_at": 1782485828
    },
    {
      "id": "d2b1c593-0281-4450-8e4b-7b531a2ffb45",
      "object": "event",
      "data": {
        "object": {
          "id": "98c85017-9016-4207-9925-de746d6ca0fe",
          "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/98c85017-9016-4207-9925-de746d6ca0fe",
          "statement_url": "http://app.example.com/statements/orders/98c85017-9016-4207-9925-de746d6ca0fe",
          "status": "paid",
          "checkout": "bed514a0-03c1-4e34-ba1b-c8c1a960dd62",
          "created_at": 1782485828,
          "updated_at": 1782485828
        }
      },
      "type": "order.created",
      "account": "c64c18d3-9fc0-4fb0-a85c-c939d9caf607",
      "created_at": 1782485828
    },
    {
      "id": "db52e03a-1efc-4dd2-ad28-ae972c26fb03",
      "object": "event",
      "data": {
        "object": {
          "id": "1ed9600f-e85e-4899-9e0d-90db15b87a4e",
          "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": 1782485827,
          "discarded_at": null,
          "created_at": 1782485828,
          "updated_at": 1782485828
        }
      },
      "type": "product.stock_adjusted",
      "account": "c64c18d3-9fc0-4fb0-a85c-c939d9caf607",
      "created_at": 1782485828
    }
  ]
}

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.