List events

Parameters

Lingara-Versionheaderstringoptional

The API version to answer this request under. Without it, an access token gets the version its client is pinned to, and a request with no token gets the current version. The version still in development is reached only by naming it here. An unknown version answers 400 with code api_version_unknown. GET /v1/versions lists the versions.

cursorquerystringoptional

Where to continue from: an earlier page's next_cursor, or a stream event's id:. A cursor older than 30 days answers 410 with code cursor_expired.

startquerystringoptional

Where to begin without a cursor: latest for events from now on, or oldest for every event still kept.

typesqueryarray of stringoptional

Only these event types, comma-separated. Without it, every type your token's scopes can read.

limitqueryintegeroptional

The most events one page returns, from 1 to 100.

Responses

200 A page of events and the cursor to continue from

itemsarray of EventEnveloperequired

idstringrequired

typestringrequired

created_atstringrequired

api_versionstringrequired

subjectstringrequired

dataobjectrequired

next_cursorstringrequired

has_morebooleanrequired

Errors

410application/json

api_version_discontinued: this request's API version has been discontinued. cursor_expired: the cursor is older than 30 days; start again without one.

4XXapplication/json

The request was refused. code says why, and error says it in words.

503application/json · text/plain

The service is temporarily unavailable; retry after the number of seconds in Retry-After. During maintenance the body is plain text rather than the error envelope.

5XXapplication/json

The request was refused. code says why, and error says it in words.

codestringrequired

Why the request was refused, as a stable code to branch on: for example insufficient_scope (403), rate_limited (429) and, for a metered client, spend_cap_reached (402) and metered_billing_inactive (402).

errorstringrequired

Example

curl "https://api.getlingara.com/v1/events" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

Prefer a library? See the Libraries section.