List Events

POST /events/list

TypeScript

TypeScript

import { Autumn } from 'autumn-js';

const autumn = new Autumn();

const { data, error } = await autumn.events.list({ customer_id: 'customer_id', feature_id: 'x' });

200

{
  "list": [
    {
      "id": "evt_36xpk2TmuQX5zVPPQ8tCtnR5Weg",
      "timestamp": 1765958215459,
      "feature_id": "credits",
      "customer_id": "0pCIbS4AMAFDB1iBMNhARWZt2gDtVwQx",
      "value": 30,
      "properties": {}
    },
    {
      "id": "evt_36xmHxxjAkqxufDf9yHAPNfRrLM",
      "timestamp": 1765956512057,
      "feature_id": "credits",
      "customer_id": "0pCIbS4AMAFDB1iBMNhARWZt2gDtVwQx",
      "value": 49,
      "properties": {}
    }
  ],
  "total": 2,
  "has_more": false,
  "offset": 0,
  "limit": 100
}

Authorizations

Authorization · string · header · required

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

Body

application/json

customer_id · string · required

Filter events by customer ID

feature_id · string string[] · required

Filter by specific feature ID(s)

offset · integer · default: 0

Number of items to skip

limit · integer · default: 100

Number of items to return. Default 100, max 1000.

custom_range · object

Filter events by time range

Show child attributes

Response

200 - application/json

list · object[] · required

Array of items for current page

Show child attributes

has_more · boolean · required

Whether more results exist after this page

offset · number · required

Current offset position

limit · number · required

Limit passed in the request

total · number · required

Total number of items returned in the current page