solarOSsolarOS Docs
Api

List endpoints use cursor-oriented pagination: limit, cursor, sortBy, and sortDir query parameters where the endpoint's contract exposes list controls. The default limit is 50 and the maximum is 100. Read meta.nextCursor from the response and keep paging while meta.hasMore is true; list responses don't promise a total count. (This matches the "Pagination" orientation page already generated in-app from apps/web/src/lib/org-api/public-docs.ts.)

TODO(owner, likely engineering): write the full page with a worked example (curl + JS/Python, matching this site's other API pages' style), sourced from apps/web/src/lib/org-api/public-docs.ts's pagination slug and cross-checked against one real list endpoint's Zod contract in apps/web/src/lib/org-api/openapi-contracts.ts.

Was this page helpful?