PApaddlehq
Events

List events

Changed on

Returns a paginated list of events that have occurred in the last 90 days. Use the query parameters to page through results.

Events older than 90 days aren't retained.

This is sometimes referred to as "the event stream."

get/events

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Query parameters

afterstring

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

per_pageinteger

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: id (for event_id).

event_typeEventTypeName[]

Return events that match the specified event type. Use a comma-separated list to specify multiple event types.

filterstring

Return entities that contain the value specified. Pass a Paddle ID or email address that appears in the event payload, or part of one. Complete Paddle IDs and email addresses match exactly; partial values match as a prefix or substring, and must be at least three characters.

tostring

Return entities up to a specific time. Pass an RFC 3339 datetime string.

fromstring

Return entities from a specific time. Pass an RFC 3339 datetime string.

Headers

Skip-Countstring

Set to true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "event_id": "evt_01gks14ge726w50ch2tmaw2a1x",
      "occurred_at": "2024-10-12T07:20:50.52Z"
    }
  ],
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355",
    "pagination": {
      "estimated_total": 999
    }
  }
}

Changes

  • v14f35a8c6ea4dRevision changes
    • info

      added the new optional query request parameter filter

    • info

      added the new optional query request parameter from

    • info

      added the new optional query request parameter to

  • v1e1ac347eb3c5Revision changes
    • info

      added the new optional header request parameter Skip-Count