List all Instances

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

curl --request GET \
  --url https://api.sandbox.teal.dev/v0/platform/instances \
  --header 'Authorization: Bearer <token>'

{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "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": "<any>",
      "children": [
        {}
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Query Parameters

accounting_package

enum<string> | null

Only return Instances using a specific accounting_package, either platform_gl or quickbooks.

Available options:

platformgl,

quickbooks

name

string | null

Only return Instances containing a specific string in their name.

expand

enum<string>[] | null

Comma-separated list of Instance expand paths.

Available options:

parent,

children

sort

enum<string> | null

Sort results

Available options:

name,

-name

limit

integer | null

default:

The number of records to return. Max limit is 100.

Required range: 1 <= x < 101

page_token

string | null

Response

200

application/json

Successful Response

next_page_token

string | null

required

The token to use to request the next page

Example:

"ikal0NEVfMhF8dJf4yQ6KQZmGD"

prev_page_token

string | null

required

The token to use to request the previous page

Example:

"vuA7JeKI5c6FLnPt5JfRcZcJxW"

records

object[]

required

List of instances

records.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

records.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"

records.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

records.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

Example:

"tier3"

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

Example:

"platformgl"

records.parent_id

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

records.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

records.parent

any | null

The Instance's parent. Included in expanded responses.

records.children

object[] | null

The Instance's children. Included in expanded responses.

records.children.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

records.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"

records.children.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

records.children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

Example:

"tier3"

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

Example:

"platformgl"

records.children.parent_id

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

records.children.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

records.children.parent

any | null

The Instance's parent. Included in expanded responses.

records.children.children

object[] | null

The Instance's children. Included in expanded responses.

records.children.children.id

string

required

The unique ID of the object.

Example:

"RKtPbubK5NcbBsUmU1ktSP"

records.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"

records.children.children.name

string

required

The name of the business.

Example:

"ACME Goods Inc"

records.children.children.subscription

enum<string>

required

The Instance's subscription tier.

Available options:

tier0,

tier1,

tier2,

tier3,

tier4,

tier5

Example:

"tier3"

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

Example:

"platformgl"

records.children.children.parent_id

string | null

The ID of the Instance's parent.

Example:

"Kv7sp6Y1gAH2vfNxAWemRy"

records.children.children.child_ids

string[] | null

The IDs of the Instance's children.

Example:

"['A5SswbYm7eZM2ec5q7Hm2t']"

records.children.children.parent

any | null

The Instance's parent. Included in expanded responses.

records.children.children.children

object[] | null

The Instance's children. Included in expanded responses.

Create an Instance Assign a Bookkeeping Provider

curl --request GET \
  --url https://api.sandbox.teal.dev/v0/platform/instances \
  --header 'Authorization: Bearer <token>'

{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "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": "<any>",
      "children": [
        {}
      ]
    }
  ]
}