GET
/
v0
/
platform
/
instances
/
{instance_id}
Retrieve an Instance
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/platform/instances/{instance_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "RKtPbubK5NcbBsUmU1ktSP",
  "entries_start": "2024-01-01T00:00:00Z",
  "name": "ACME Goods Inc",
  "subscription": "tier3",
  "accounting_package": "platformgl",
  "parent_id": "Kv7sp6Y1gAH2vfNxAWemRy",
  "child_ids": "['A5SswbYm7eZM2ec5q7Hm2t']",
  "parent": {
    "id": "RKtPbubK5NcbBsUmU1ktSP",
    "entries_start": "2024-01-01T00:00:00Z",
    "name": "ACME Goods Inc",
    "subscription": "tier3",
    "accounting_package": "platformgl",
    "parent_id": "Kv7sp6Y1gAH2vfNxAWemRy",
    "child_ids": "['A5SswbYm7eZM2ec5q7Hm2t']",
    "parent": {},
    "children": [
      {}
    ]
  },
  "children": [
    {
      "id": "RKtPbubK5NcbBsUmU1ktSP",
      "entries_start": "2024-01-01T00:00:00Z",
      "name": "ACME Goods Inc",
      "subscription": "tier3",
      "accounting_package": "platformgl",
      "parent_id": "Kv7sp6Y1gAH2vfNxAWemRy",
      "child_ids": "['A5SswbYm7eZM2ec5q7Hm2t']",
      "parent": {},
      "children": [
        {}
      ]
    }
  ],
  "latest_journal_entry_datetime": "2024-10-01T00:00:00Z"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
instance_id
string
required

The instance ID

Query Parameters

​
expand
enum<string>[] | null

Comma-separated list of Instance expand paths.

Response

Successful Response

​
id
string
required

The unique ID of the object.

Examples:

"RKtPbubK5NcbBsUmU1ktSP"

​
entries_start
string<date-time>
required

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.

Examples:

"2024-01-01T00:00:00Z"

​
name
string
required

The name of the business.

Examples:

"ACME Goods Inc"

​
subscription
enum<string>
required

The Instance's subscription tier.

Available options:
tier0,
tier1,
tier2,
tier3,
tier4,
tier5
​
accounting_package
enum<string>
required

The type of accounting package the Instance uses as the source of truth for their books.

Available options:
platformgl,
quickbooks
​
latest_journal_entry_datetime
string<date-time> | null
required

The datetime of the latest journal entry if one exists, otherwise null

Examples:

"2024-10-01T00:00:00Z"

​
parent_id
string | null

The ID of the Instance's parent.

Examples:

"Kv7sp6Y1gAH2vfNxAWemRy"

​
child_ids
string[] | null

The IDs of the Instance's children.

Examples:

"['A5SswbYm7eZM2ec5q7Hm2t']"

​
parent
object | null

The Instance's parent. Included in expanded responses.

​
children
Instance · object[] | null

The Instance's children. Included in expanded responses.