Instances
Retrieve an Instance
Retrieves the details of an existing Instance.
GET
/
v0
/
platform
/
instances
/
{instance_id}
Authorizations
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
instance_id
string
requiredThe instance ID
Query Parameters
expand
enum<string>[] | null
Comma-separated list of Instance expand paths.
Available options:
parent
, children
Response
200 - application/json
id
string
requiredThe unique ID of the object.
entries_start
string
requiredThe datetime in UTC time from which the API will sync an Instance's accounting data. Transactions or journal entries cannot be entered before this date.
name
string
requiredThe name of the business.
subscription
enum<string>
requiredThe Instance's subscription tier.
Available options:
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
accounting_package
enum<string>
requiredThe type of accounting package the Instance uses as the source of truth for their books.
Available options:
platformgl
, quickbooks
parent_id
string | null
The ID of the Instance's parent.
child_ids
string[] | null
The IDs of the Instance's children.
parent
any | null
The Instance's parent. Included in expanded responses.
children
object[] | null
The Instance's children. Included in expanded responses.