List widgets
Returns widgets, newest first. Pagination is cursor-based. Pass the next_cursor from the previous response without changing it. Offsets are not supported, because a widget created mid-pagination would shift them.
GET/widgets
Paging through every widget
Read has_more to decide whether to continue, and pass next_cursor back as
cursor without changing it. Do not build the cursor yourself. Its format is
not part of the contract and it can change.
cursor=""
while :; do
page=$(curl -s "https://api.example.com/v1/widgets?limit=100&cursor=$cursor" \
-H "Authorization: Bearer $API_KEY")
echo "$page" | jq -r '.data[].id'
[ "$(echo "$page" | jq -r '.has_more')" = "true" ] || break
cursor=$(echo "$page" | jq -r '.next_cursor')
doneOffsets are deliberately not supported. A widget created while you page would shift every offset after it, so a loop would repeat one record or skip another. A cursor names a position in the result set instead, which stays correct.
Authorizations
Authorizationbearerin headerrequiredQuery parameters
statusenum<string>one of: draft, active, archivedReturn only widgets in this state. All states are returned by default.
limitintegerdefault: 20range: 1–100Records per page. A request above the maximum is clamped, not rejected.
cursorstringThe next_cursor from a previous response. Returns the page after it.
Response
A page of widgets.
dataobject[]requiredhas_morebooleanrequiredWhether another page follows this one.
next_cursorstringPass this back as cursor. Absent on the last page.
The API key is missing, malformed or revoked.
errorobjectrequired