Skip to main content
GET
List Alerts

Authorizations

X-API-KEY
string
header
required
X-CONNECTION-ID
string
header
required

Query Parameters

enableCursor
boolean
default:false

Enable cursor based pagination instead of default offset-based pagination

updatedSince
string<date-time> | null

Only records whose updated_at is at or after this time. Leen bumps updated_at whenever any field on a record changes, so this is the filter for an incremental sync: it returns records that are new and records that changed, and nothing that has stood still. Example: 2021-01-01T00:00:00+00:00.

Example:

"2021-01-01T00:00:00+00:00"

limit
integer
default:100

How many records to return per page. The walk is the same either way; a larger page means fewer round trips and more memory per response.

Required range: 1 <= x <= 500
offset
integer
default:0

Where to start, counted in records. Offset paging is stable only while the underlying data is; prefer the cursor for anything long-running.

Required range: x >= 0
excludeTotal
boolean
default:false

Skip counting the total. Counting is the expensive half of a large query, so set this when you are walking every page anyway and never read total. total comes back null.

cursor
string | null

Opaque position of the next page, taken from the previous response. Ignore its contents; it encodes where the walk had reached.

Response

Successful Response

count
integer
required

Number of items return in the response

items
CSPMAlert · object[]
required

The records on this page.

total
integer | null

Total number of items that can be returned