Skip to main content
GET
List usage events

Authorizations

Authorization
string
header
required

One of your API keys (zpl_live_… or zpl_test_…), created at https://caretly.dev/console/keys. Revoked keys are refused immediately.

Query Parameters

from
string<date-time>

Start of the window (inclusive), RFC 3339. URL-encode a + offset as %2B, or use Z.

Example:

"2026-10-01T00:00:00Z"

to
string<date-time>

End of the window (exclusive), RFC 3339.

Example:

"2026-10-15T00:00:00Z"

limit
integer
default:100

Events per page.

Required range: 1 <= x <= 1000
cursor
string

The next_cursor of the previous page, unchanged.

Response

A page of events.

from
string<date-time>
required

Start of the window used (inclusive).

to
string<date-time>
required

End of the window used (exclusive).

events
object[]
required
next_cursor
string | null
required

Pass as cursor for the next page; null on the last page.