Skip to main content
GET
List business accounts in an environment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Query Parameters

limit
integer
default:50

Maximum number of business accounts to return

Required range: 1 <= x <= 100
offset
integer
default:0

Number of business accounts to skip

Required range: x >= 0

Case-insensitive match on name or external reference

Maximum string length: 255

Response

Successful response with business accounts

businessAccounts
object[]
required

Business accounts in the environment matching the query

count
integer
required

Total number of business accounts matching the filter

limit
integer

Maximum number of business accounts returned

offset
integer

Number of business accounts skipped

Last modified on August 26, 2026