Skip to main content
GET
/
api
/
v1
/
events
JavaScript
import CheckoutIntents from 'checkout-intents';

const client = new CheckoutIntents({
  apiKey: process.env['CHECKOUT_INTENTS_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const event of client.events.list()) {
  console.log(event.id);
}
{
  "pageInfo": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>"
  },
  "data": [
    {
      "id": "evt_1234567890",
      "object": "event",
      "type": "checkout_intent.offer_retrieved",
      "createdAt": "2026-03-25T00:00:00Z",
      "source": {
        "id": "ci_1234567890",
        "type": "checkout_intent"
      },
      "data": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Rye API key

Query Parameters

limit
integer<int32>

Maximum number of results to return (default 100)

Required range: 1 <= x <= 100
after
string
before
string

Response

Events list response

pageInfo
object
required
data
object[]
required