Skip to main content
GET
List companies

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

page
number
default:1

Page number

Required range: x >= 1
limit
number
default:20

Items per page

Required range: 1 <= x <= 100
orderBy
enum<string>
default:created_at

Field to order by

Available options:
name,
created_at,
updated_at
orderDirection
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
includeTeamMembers
boolean
default:false

Include assigned MSP team members on each company

teamMemberRoleName
string

Only companies with a team member in this company role (e.g. vCIO); implies includeTeamMembers

Maximum string length: 200
teamMemberUserId
string<uuid>

Only companies this user is assigned to

teamMemberName
string

Only companies with an assigned member whose name matches

Maximum string length: 200
teamMemberEmail
string<email>

Only companies with an assigned member with this email

Maximum string length: 320

Response

List of companies

data
object[]
required

Array of companies

pagination
object
required