Skip to main content
GET
Retrieve Accounts that belong to a Company

Authorizations

Authorization
string
header
required

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

Headers

Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Path Parameters

company-id
string
required

Company ID

Query Parameters

page[limit]
integer<int32>
default:25

The maximum number of paginated results to return

Required range: x <= 100
page[after]
string

The cursor to start paginating after

page[before]
string

The cursor to stop paginating at

filter[account_types]
array

AccountType filter

search[datagrid]
string

Search string for datagrid queries

filter[material_rates]
boolean

Filter on whether the Account has associated MaterialRates

filter[discarded]
boolean

Only show discarded Accounts

filter[department_ids]
array

The associated Department IDs. Use 'none' to filter for records without a Department.

filter[connected_company][company_types]
array

Connected Company Type enum filters (see CompanyType enum for the list of values)

filter[auto_add_ons]
boolean

Filter on whether the resource (e.g. Account, User) has associated AutoAddOns

Response

OK

data
Account-Read · object[]
required