Skip to content

Pagination & limits

List endpoints return a consistent envelope and accept limit and cursor query parameters:

{
"data": [
/* … items … */
],
"next_cursor": "eyJvIjoxMDB9"
}
  • limit — page size, default 50, max 200. Values outside the range are clamped.
  • cursor — pass the previous response’s next_cursor to fetch the next page.
  • next_cursor is null on the last page.
Terminal window
# First page
curl -s "https://api.halyard-ai.com/api/v1/projects?limit=100" \
-H "Authorization: Bearer $HALYARD_TOKEN"
# Next page
curl -s "https://api.halyard-ai.com/api/v1/projects?limit=100&cursor=eyJvIjoxMDB9" \
-H "Authorization: Bearer $HALYARD_TOKEN"

Treat the cursor as opaque — its encoding may change. Always follow next_cursor; don’t construct cursors yourself.

Requests are limited per token (per minute). Every response carries:

HeaderMeaning
RateLimit-LimitYour per-minute ceiling.
RateLimit-RemainingRequests left in the current window.
Retry-AfterOn a 429, seconds to wait before retrying.

When you exceed the limit you get 429 too_many_requests. Back off until Retry-After elapses, then resume. Well-behaved clients watch RateLimit-Remaining and pace themselves before hitting the wall.