Instances
List all Instances
Lists all Instances belonging to a Platform.
GET
/
v0
/
platform
/
instances
Authorizations
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
accounting_package
enum<string> | null
Only return Instances using a specific accounting_package
,
either platform_gl
or quickbooks
.
Available options:
platformgl
, quickbooks
name
string | null
Only return Instances containing a specific string in
their name
.
expand
enum<string>[] | null
Comma-separated list of Instance expand paths.
Available options:
parent
, children
sort
enum<string> | null
Sort results
Available options:
name
, -name
limit
integer | null
default: 50The number of records to return. Max limit is 100.
page_token
string
Response
200 - application/json
next_page_token
string | null
requiredThe token to use to request the next page
prev_page_token
string | null
requiredThe token to use to request the previous page
records
object[]
requiredList of instances