Skip to main content
GET
/
events
List all events
curl --request GET \
  --url https://api.getlago.com/api/v1/events \
  --header 'Authorization: Bearer <token>'
{
  "events": [
    {
      "transaction_id": "transaction_1234567890",
      "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "code": "storage",
      "timestamp": "2022-04-29T08:59:51.123Z",
      "lago_subscription_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "external_subscription_id": "sub_1234567890",
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "precise_total_amount_cents": "1234.56",
      "properties": {
        "gb": 10
      },
      "created_at": "2022-04-29T08:59:51Z"
    }
  ],
  "meta": {
    "current_page": 2,
    "total_pages": 4,
    "total_count": 70,
    "next_page": 3,
    "prev_page": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getlago.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer

Page number.

Example:

1

​
per_page
integer

Number of records per page.

Example:

20

​
external_subscription_id
string

External subscription ID

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

​
code
string

Filter events by its code.

Example:

"event-123"

​
timestamp_from_started_at
boolean

Requires external_subscription_id to be set. Filter events by timestamp after the subscription started at datetime.

Example:

true

​
timestamp_from
string<date-time>

Filter events by timestamp starting from a specific date.

Example:

"2022-08-08T00:00:00Z"

​
timestamp_to
string<date-time>

Filter events by timestamp up to a specific date.

Example:

"2022-08-08T00:00:00Z"

Response

Events

​
events
object[]
required
​
meta
object
required