Skip to main content
List all users with access to a business.
GET /api/v1/businesses/:businessId/users

Parameters

Path

NameTypeRequiredDescription
businessIdstringYesThe business ID
This endpoint has no query parameters.

Request example

curl --request GET 'https://payments.bleepay.com/api/v1/businesses/biz_abc123/users' \
  --header 'Authorization: Bearer <business_token>'

Response

Returns an array of business user objects. Business user object:
FieldTypeDescription
idstringMembership identifier
userIdstringUser identifier
rolestringUser’s role in the business
statusstringMembership status
createdAtstringISO 8601 timestamp

Example response

[
  {
    "id": "bu_xyz",
    "userId": "usr_abc123",
    "role": "ADMIN",
    "status": "ACTIVE",
    "createdAt": "2026-06-09T12:00:00.000Z"
  }
]