Skip to main content
GET
List watchlist items

Authorizations

apikey
string
header
required

Your Eventory API key. Sent as the apikey request header.

Query Parameters

limit
integer

Maximum number of items to return. Omit to return the entire watchlist. A value outside 1..1000 is rejected with 400.

Required range: 1 <= x <= 1000
Example:

500

offset
integer
default:0

Number of items to skip before collecting the page. Defaults to 0. Items are ordered by creation time, newest first.

Required range: x >= 0
Example:

1000

Response

One page of watchlist items, with the totals needed to page through the rest.

items
object[]
required

This page of watchlist items, newest first.

total
integer
required

Total items on the account, independent of limit and offset.

Example:

6788

offset
integer
required

The offset that was applied.

Example:

1000

limit
integer | null
required

The limit that was applied; null when none was passed.

Example:

1000

has_more
boolean
required

true when items remain after this page.

Example:

true