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
Instances
Retrieve an Instance
Retrieves the details of an existing Instance.
GET
/
v0
/
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": {
"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
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The instance ID
Query Parameters
Comma-separated list of Instance expand paths.
Response
200
application/json
Successful Response
The response is of type object
.
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"
}
Assistant
Responses are generated using AI and may contain mistakes.