Skip to main content
GET
/
v0
/
platform
/
instances
List all 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": "<string>",
      "entries_start": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "accounting_package": "platformgl",
      "accounting_basis": "accrual"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

Query Parameters

​
name
string | null

Only return Instances containing a specific string in their name.

​
sort
enum<string> | null

Sort results

Available options:
name,
-name
​
limit
integer
default:50

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

Required range: x >= 1
​
page_token
string | null

Opaque page token

Response

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
Instance · object[]
required

List of instances