Retrieve an Instance

API overview

Teal API Endpoints

Categorization
Chart of Accounts Templates
Instances
Journal Entries
Ledgers
Line Entries
Payables
Platform
Quickbooks
Receivables
Reports
Tags
Transaction Sources
Transactions
Transfers

API Migration

Migration Guides
Deprecated Endpoints

GET

platform

instances

{instance_id}

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": {},
  "children": [
    {}
  ]
}

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

Successful Response

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

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.

Example:

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

name

string

required

The name of the business.

Example:

"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

parent_id

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

parent

object | null

The Instance's parent. Included in expanded responses.

parent.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

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

Example:

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

parent.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

parent.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

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

parent.parent_id

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

parent.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

parent.parent

object | null

The Instance's parent. Included in expanded responses.

parent.parent.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

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

Example:

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

parent.parent.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

parent.parent.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

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

parent.parent.parent_id

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

parent.parent.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

parent

object

parent.parent.children

object[] | null

The Instance's children. Included in expanded responses.

parent.parent.children.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

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

Example:

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

parent.parent.children.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

parent.parent.children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

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

parent.parent.children.parent_id

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

parent.parent.children.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

parent.parent.children.parent

object | null

The Instance's parent. Included in expanded responses.

parent.parent.children.children

object[] | null

The Instance's children. Included in expanded responses.

parent.children

object[] | null

The Instance's children. Included in expanded responses.

parent.children.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

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

Example:

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

parent.children.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

parent.children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

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

parent.children.parent_id

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

parent.children.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

parent.children.parent

object | null

The Instance's parent. Included in expanded responses.

parent.children.parent.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

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

Example:

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

parent.children.parent.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

parent.children.parent.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

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

parent.children.parent.parent_id

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

parent.children.parent.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

parent

object

parent.children.parent.children

object[] | null

The Instance's children. Included in expanded responses.

parent.children.children

object[] | null

The Instance's children. Included in expanded responses.

parent.children.children.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

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

Example:

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

parent.children.children.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

parent.children.children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

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

parent.children.children.parent_id

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

parent.children.children.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

parent.children.children.parent

object | null

The Instance's parent. Included in expanded responses.

parent.children.children.children

object[] | null

The Instance's children. Included in expanded responses.

children

object[] | null

The Instance's children. Included in expanded responses.

children.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

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.

Example:

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

children.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

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

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

children.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

children.parent

object | null

The Instance's parent. Included in expanded responses.

children.parent.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

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

Example:

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

children.parent.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

children.parent.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

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

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

children.parent.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

parent

object

children.parent.children

object[] | null

The Instance's children. Included in expanded responses.

children.parent.children.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

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

Example:

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

children.parent.children.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

children.parent.children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

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

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

children.parent.children.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

children.parent.children.parent

object | null

The Instance's parent. Included in expanded responses.

children.parent.children.children

object[] | null

The Instance's children. Included in expanded responses.

children.children

object[] | null

The Instance's children. Included in expanded responses.

children.children.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

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.

Example:

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

children.children.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

children.children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

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

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

children.children.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

children.children.parent

object | null

The Instance's parent. Included in expanded responses.

children.children.parent.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

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

Example:

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

children.children.parent.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

children.children.parent.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

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

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

children.children.parent.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

parent

object

children.children.parent.children

object[] | null

The Instance's children. Included in expanded responses.

children.children.children

object[] | null

The Instance's children. Included in expanded responses.

children.children.children.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

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.

Example:

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

children.children.children.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

children.children.children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

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

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

children.children.children.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

children.children.children.parent

object | null

The Instance's parent. Included in expanded responses.

children.children.children.children

object[] | null

The Instance's children. Included in expanded responses.

Delete a Ledger Template Delete 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": {},
  "children": [
    {}
  ]
}