Instances
Retrieve an Instance
Retrieves the details of an existing Instance.
GET
/
v0
/
platform
/
instances
/
{instance_id}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The instance ID
Query Parameters
Comma-separated list of Instance expand paths.
Available options:
parent
, children
Response
200 - application/json
The unique ID of the object.
The 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.
The name of the business.
The Instance's subscription tier.
Available options:
tier0
, tier1
, tier2
, tier3
, tier4
, tier5
The type of accounting package the Instance uses as the source of truth for their books.
Available options:
platformgl
, quickbooks
The ID of the Instance's parent.
The IDs of the Instance's children.
The Instance's parent. Included in expanded responses.
The Instance's children. Included in expanded responses.