Get Instance Details

GET

platform

instances

{instance_id}

Authorization

Path

curl --request GET \
  --url https://api.sandbox.teal.dev/v0/platform/instances/{instance_id} \
  --header 'Authorization: <authorization>'

{
  "entries_start": "2022-01-01T00:00:00Z",
  "id": "RKtPbubK5NcbBsUmU1ktSP",
  "name": "City Center Veterinarian",
  "subscription": "tier1"
}

Authorization

string

headerrequired

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

instance_id

string

required

The instance ID

200 - application/json

entries_start

string | null

required

The earliest possible datetime for the instance's journal entries

string

required

name

string

required

subscription

enum<string>

required

Available options:

tier0,

tier1,

tier2

curl --request GET \
  --url https://api.sandbox.teal.dev/v0/platform/instances/{instance_id} \
  --header 'Authorization: <authorization>'

{
  "entries_start": "2022-01-01T00:00:00Z",
  "id": "RKtPbubK5NcbBsUmU1ktSP",
  "name": "City Center Veterinarian",
  "subscription": "tier1"
}