- Guides
- API Reference
- Changelog
- Categorization
- Chart of Accounts Templates
- Instances
- Journal Entries
- Ledgers
- Line Entries
- Payables
- Platform
- Quickbooks
- Receivables
- Reports
- Tags
- Transaction Sources
- Transactions
- Transfers
- Migration Guides
- Deprecated Endpoints
Teal API Endpoints
API Migration
List all Instances
Lists all Instances belonging to a Platform.
The access token received from the authorization server in the OAuth 2.0 flow.
Only return Instances using a specific accounting_package,
either platform_gl or quickbooks.
Only return Instances containing a specific string in
their name.
Comma-separated list of Instance expand paths.
Sort results
The number of records to return. Max limit is 100.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
Only return Instances using a specific accounting_package,
either platform_gl or quickbooks.
platformgl, quickbooks Only return Instances containing a specific string in
their name.
Comma-separated list of Instance expand paths.
parent, children Sort results
name, -name The number of records to return. Max limit is 100.
Response
The token to use to request the next page
The token to use to request the previous page
List of instances
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.
tier0, tier1, tier2, tier3, tier4, tier5 The type of accounting package the Instance uses as the source of truth for their books.
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.
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.
tier0, tier1, tier2, tier3, tier4, tier5 The type of accounting package the Instance uses as the source of truth for their books.
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.
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.
tier0, tier1, tier2, tier3, tier4, tier5 The type of accounting package the Instance uses as the source of truth for their books.
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.
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.
tier0, tier1, tier2, tier3, tier4, tier5 The type of accounting package the Instance uses as the source of truth for their books.
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.
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.
tier0, tier1, tier2, tier3, tier4, tier5 The type of accounting package the Instance uses as the source of truth for their books.
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.
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.
tier0, tier1, tier2, tier3, tier4, tier5 The type of accounting package the Instance uses as the source of truth for their books.
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.