Instances
Get Instances
Get all instances on the platform.
GET
/
v0
/
platform
/
instances
Authorization
Query
curl --request GET \
--url https://api.sandbox.teal.dev/v0/platform/instances \
--header 'Authorization: <authorization>'
{
"next_page_token": "<string>",
"prev_page_token": "<string>",
"records": [
{
"entries_start": "2022-01-01T00:00:00Z",
"id": "RKtPbubK5NcbBsUmU1ktSP",
"name": "City Center Veterinarian",
"subscription": "tier1"
}
]
}
Authorizations
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
accounting_package
enum<string> | null
The accounting backend of the instances to return
Available options:
platformgl
, quickbooks
limit
integer | null
The number of records to return. Max limit is 100.
page_token
string
Response
200 - application/json
next_page_token
string | null
requiredThe token to use to request the next page
prev_page_token
string | null
requiredThe token to use to request the previous page
records
object[]
requiredList of instances
curl --request GET \
--url https://api.sandbox.teal.dev/v0/platform/instances \
--header 'Authorization: <authorization>'
{
"next_page_token": "<string>",
"prev_page_token": "<string>",
"records": [
{
"entries_start": "2022-01-01T00:00:00Z",
"id": "RKtPbubK5NcbBsUmU1ktSP",
"name": "City Center Veterinarian",
"subscription": "tier1"
}
]
}