Skip to content
/customers

List business customers

Request

Returns customers associated with the business. By default returns only ACTIVE customers; pass ?status=DELETED to list soft-deleted customers or ?status=ALL to list both populations.

Security
oauth2ClientCredentials(Required scopes: customers:read)
Query
pagenumber
Example:page=1
limitnumber
Example:limit=50
statusstring

Filter by customer status. Defaults to ACTIVE when omitted.

Enum:"ACTIVE""DELETED""ALL"
Headers
business_idstringrequired

Business identifier for the request

curl -i -X GET \
  'https://developer.boyahq.com/_mock/v2/openapi/customers?page=1&limit=50&status=ACTIVE' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'business_id: string'

Responses

Customer list returned successfully