Pagination

Every list returns the newest first, a page at a time. To read the next page, pass the last id you have.

Docs menu

JSON

{
  "object": "list",
  "data": [
    "...objects, newest first..."
  ],
  "has_more": true,
  "next_starting_after": "chk_0Lr8KpQ2aB3xYw5nT7pUeC"
}
  • limit is 1 to 100. The default is 20. Anything else answers limit_invalid.
  • starting_after is the id of the last object you have. The next page starts after it.
  • When has_more is true, next_starting_after is the value to pass. When it is false, you have everything.
  • An id from another account or the other mode answers cursor_invalid.

Ids

An id is a prefix, an underscore and 22 letters and digits, for example chk_0Lr8KpQ2aB3xYw5nT7pUeC. The prefix tells you the kind. Ids sort in the order they were made, so newer ids sort later. Treat an id as an opaque string and do not parse the rest.

PrefixObject
chk_Check
mon_Monitor
chg_Monitor change
rep_Report
rel_Press release
led_Ledger entry
evt_Event
req_Request (the Request-Id)