Retrieve an Instance

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.

Available options:

parent,

children

Response

200 - application/json

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

entries_start

string

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.

string

required

The unique ID of the object.

name

string

required

The name of the business.

subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

child_ids

string[] | null

The IDs of the Instance's children.

children

object[] | null

The Instance's children. Included in expanded responses.

children.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

children.entries_start

string

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.

children.id

string

required

The unique ID of the object.

children.name

string

required

The name of the business.

children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

children.child_ids

string[] | null

The IDs of the Instance's children.

children.children

object[] | null

The Instance's children. Included in expanded responses.

children.children.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

children.children.entries_start

string

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.

children.children.id

string

required

The unique ID of the object.

children.children.name

string

required

The name of the business.

children.children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

children.children.child_ids

string[] | null

The IDs of the Instance's children.

children.children.children

object[] | null

The Instance's children. Included in expanded responses.

children.children.children.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

children.children.children.entries_start

string

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.

children.children.children.id

string

required

The unique ID of the object.

children.children.children.name

string

required

The name of the business.

children.children.children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

children.children.children.child_ids

string[] | null

The IDs of the Instance's children.

children.children.children.children

object[] | null

The Instance's children. Included in expanded responses.

children.children.children.parent

any | null

The Instance's parent. Included in expanded responses.

children.children.children.parent_id

string | null

The ID of the Instance's parent.

children.children.parent

any | null

The Instance's parent. Included in expanded responses.

children.children.parent_id

string | null

The ID of the Instance's parent.

children.parent

any | null

The Instance's parent. Included in expanded responses.

children.parent_id

string | null

The ID of the Instance's parent.

parent

any | null

The Instance's parent. Included in expanded responses.

parent_id

string | null

The ID of the Instance's parent.

API overview

Teal API Endpoints

API Migration

Retrieve an Instance

Authorizations

Path Parameters

Query Parameters

Response