Get Teal instances

GET /api/v1/businesses/teal-instances

List Teal instances with cursor-based pagination.

  • enriched: Whether to enrich instances with business information (default: true)
  • cursor: Cursor for pagination
  • limit: Maximum number of records to return
  • direction: Pagination direction ('next' or 'prev')
Operation ID: get_teal_instances_api_v1_businesses_teal_instances_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

enriched boolean default: True

Whether to enrich instances with business information

cursor string

Cursor for pagination

limit integer

Pagination limit

direction string default: next

Pagination direction: 'next' or 'prev'

include_total_count boolean default: False

Whether to include total count (expensive - avoid if possible)

sort_by string

Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.

descending boolean default: True

Sort direction: true for descending (newest/largest first), false for ascending

Responses

200 Successful Response

Schema: TealInstanceCursorListResponse

items array · TealInstanceResponse requiredTealInstanceResponse

List of items

7 fields
id string

Teal instance ID

company_name string

Company name

business_name string

Associated business name

business_id string

Associated business ID

environment string

Environment name

entries_start string · date-time

Entries start date

status string

Instance status

total integer

Total number of items (null when not calculated for performance)

limit integer

Pagination limit

next_cursor string

Cursor for next page

prev_cursor string

Cursor for previous page

has_next boolean required

Whether there are more items

has_prev boolean required

Whether there are previous items

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError
5 fields
loc array · string | integer required
msg string required
type string required
input object
ctx object