Skip to main content
GET
/
v1
/
customers
List customers
curl --request GET \
  --url https://api-dev.bsa.ai/v1/customers \
  --header 'Authorization: Bearer <token>'

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.

Returns a paginated page of customers. See Pagination for the common query parameter contract.

Query parameters

page
integer
default:"1"
rows
integer
default:"10"
Page size, max 100.
orderBy
string
Column to sort by. Common values: id, displayName, submittedDate, activationDate.
sortOrder
string
ASC or DESC.

Example

curl -sf "$BASE/v1/customers?page=1&rows=25&orderBy=submittedDate&sortOrder=DESC" \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "items": [
    {
      "id": "42",
      "accountNo": "000000042",
      "status": "Active",
      "active": true,
      "officeId": "1",
      "displayName": "Ada Lovelace",
      "activationDate": "2026-05-22"
    }
  ],
  "total": 1284,
  "page": 1,
  "rowsPerPage": 25
}
Each items entry has the same shape as the customer object.