Skip to main content
GET
List sub accounts

Authorizations

Authorization
string
header
required

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

Query Parameters

Search sub account name, unique ID, email, or phone.

Maximum string length: 255
sort
enum<string>
default:created_on

Sort field.

Available options:
created_on,
name,
unique_identification_number,
pay_terms
direction
enum<string>
default:asc

Sort direction.

Available options:
asc,
desc
per_page
integer
default:25

Number of records per page.

Required range: 1 <= x <= 100

Response

Sub accounts returned.

data
object[]
required
pagination
object
required
Last modified on July 20, 2026