Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.api.bsa.ai/llms.txt

Use this file to discover all available pages before exploring further.

List endpoints accept the same set of pagination query parameters.

​
Query parameters

​
page
integer
default:"1"
Which page to fetch. 1-indexed.
​
rows
integer
default:"10"
Page size. Maximum 100.
​
orderBy
string
Column to sort by. Valid column names depend on the resource — see the relevant endpoint page.
​
sortOrder
string
Sort direction. One of ASC or DESC.

​
Response shape

Every paginated list returns the same envelope: 
{
  "items": [ /* page of resources */ ],
  "total": 1284,
  "page": 1,
  "rowsPerPage": 10
}
  • items — the page of records.
  • total — total count matching the filter (not just this page).
  • page, rowsPerPage — echoed from the request.

​
Example

Fetch the second page of customers, 25 per page: 
curl -sf "$BASE/v1/customers?page=2&rows=25" \
  -H "Authorization: Bearer $TOKEN"

​
Validation errors

ConditionFieldError
rows > 100pagerows value too large, must be less than 100
page < 1pagepage value too small, must be larger than 0
Non-numeric page or rowspagepage conversion: ...