Skip to main content
POST
/
v1
/
events.list
Typescript (SDK)
import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.events.list({
  limit: 50,
  customerId: "cus_123",
});
{
  "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
}

​
Body Parameters

​
Response

{
  "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.

Headers

​
x-api-version
string
default:2.1
required

Body

application/json
​
offset
integer
default:0

Number of items to skip

Required range: 0 <= x <= 9007199254740991
​
limit
integer
default:100

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

Required range: 1 <= x <= 1000
​
customer_id
string

Filter events by customer ID

​
feature_id

Filter by specific feature ID(s)

Minimum string length: 1
​
custom_range
object

Filter events by time range

Response

200 - application/json

OK

​
list
object[]
required

Array of items for current page

​
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