List Events

GET

events

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.events.list(
    page=1,
    limit=10,
    sorting=['-timestamp'],
)
print(response)

import { createPolar } from "@polar-sh/sdk/2027-01";

const polar = createPolar({
  accessToken: "polar_oat_xxx",
});

const response = await polar.events.list(
  {
    "page": 1,
    "limit": 10,
    "sorting": [
      "-timestamp"
    ]
  },
);
console.log(response);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polar.sh/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://api.polar.sh/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://api.polar.sh/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/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

{
  "items": [
    {
      "id": "<string>",
      "timestamp": "2026-01-01T00:00:00.000000Z",
      "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
      "customer_id": "<string>",
      "customer": {
        "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
        "created_at": "2026-01-01T00:00:00.000000Z",
        "modified_at": "2026-01-01T00:00:00.000000Z",
        "metadata": {},
        "email": "[email protected]",
        "email_verified": true,
        "type": "individual",
        "name": "John Doe",
        "billing_name": "John Doe",
        "billing_address": {
          "country": "US",
          "line1": "<unknown>",
          "line2": "<unknown>",
          "postal_code": "<unknown>",
          "city": "<unknown>",
          "state": "<unknown>"
        },
        "tax_id": {
          "[0]": "<string>"
        },
        "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
        "deleted_at": "2026-01-01T00:00:00.000000Z",
        "first_user_event_at": "2026-01-01T00:00:00.000000Z",
        "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404",
        "external_id": "usr_1337",
        "locale": "<string>",
        "default_payment_method_id": "<string>"
      },
      "external_customer_id": "<string>",
      "label": "<string>",
      "source": "system",
      "name": "meter.credited",
      "metadata": {
        "meter_id": "<string>",
        "units": 123,
        "rollover": true,
        "reason": "benefit"
      },
      "member_id": "<string>",
      "external_member_id": "<string>",
      "child_count": 0,
      "parent_id": "<string>"
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

You can generate a Personal Access Token from your settings.

Scopes

events:read

pat

events:write

pat

events:read

oat

events:write

oat

Query Parameters

organization_id

Filter by organization ID. The organization ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

query

string | null

Query to filter events.

Minimum string length: 3

filter

string | null

Filter events following filter clauses. JSON string following the same schema a meter filter clause.

start_timestamp

string<date-time> | null

Filter events after this timestamp.

end_timestamp

string<date-time> | null

Filter events before this timestamp.

customer_id

Filter by customer ID. The customer ID.

external_customer_id

Filter by external customer ID.

meter_id

string<uuid4> | null

Filter by a meter filter clause. The meter ID.

name

Filter by event name.

source

Filter by event source.

Available options:

system,

user

parent_id

string<uuid4> | null

When combined with depth, use this event as the anchor instead of root events. The event ID.

depth

integer | null

Fetch descendants up to this depth. When set: 0=root events only, 1=roots+children, etc. Max 5. When not set, returns all events.

Required range: 0 <= x <= 5

page

integer

default:1

Page number, defaults to 1.

limit

integer

default:10

Size of a page, defaults to 10. Maximum is 100.

sorting

enum<string>[] | null

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Available options:

timestamp,

-timestamp

metadata

MetadataQuery · object | null

Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.

Show child attributes

Response

Successful Response

ListResource[Event]
ListResourceWithCursorPagination[Event]

items

required

An event created by Polar when credits are added to a customer meter.

Show child attributes

pagination

Pagination · object

required

Show child attributes

⌘I

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.events.list(
    page=1,
    limit=10,
    sorting=['-timestamp'],
)
print(response)

import { createPolar } from "@polar-sh/sdk/2027-01";

const polar = createPolar({
  accessToken: "polar_oat_xxx",
});

const response = await polar.events.list(
  {
    "page": 1,
    "limit": 10,
    "sorting": [
      "-timestamp"
    ]
  },
);
console.log(response);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polar.sh/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://api.polar.sh/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://api.polar.sh/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/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

{
  "items": [
    {
      "id": "<string>",
      "timestamp": "2026-01-01T00:00:00.000000Z",
      "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
      "customer_id": "<string>",
      "customer": {
        "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
        "created_at": "2026-01-01T00:00:00.000000Z",
        "modified_at": "2026-01-01T00:00:00.000000Z",
        "metadata": {},
        "email": "[email protected]",
        "email_verified": true,
        "type": "individual",
        "name": "John Doe",
        "billing_name": "John Doe",
        "billing_address": {
          "country": "US",
          "line1": "<unknown>",
          "line2": "<unknown>",
          "postal_code": "<unknown>",
          "city": "<unknown>",
          "state": "<unknown>"
        },
        "tax_id": {
          "[0]": "<string>"
        },
        "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
        "deleted_at": "2026-01-01T00:00:00.000000Z",
        "first_user_event_at": "2026-01-01T00:00:00.000000Z",
        "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404",
        "external_id": "usr_1337",
        "locale": "<string>",
        "default_payment_method_id": "<string>"
      },
      "external_customer_id": "<string>",
      "label": "<string>",
      "source": "system",
      "name": "meter.credited",
      "metadata": {
        "meter_id": "<string>",
        "units": 123,
        "rollover": true,
        "reason": "benefit"
      },
      "member_id": "<string>",
      "external_member_id": "<string>",
      "child_count": 0,
      "parent_id": "<string>"
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

General

Core API

Customer Portal API

Webhook Events

Integrations

Authorizations

Scopes

Query Parameters

Response