Start free trial

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

enrichedbooleandefault: True

Whether to enrich instances with business information

cursorstring

Cursor for pagination

limitinteger

Pagination limit

directionstringdefault: next

Pagination direction: 'next' or 'prev'

include_total_countbooleandefault: False

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

sort_bystring

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

descendingbooleandefault: True

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

Responses

200Successful Response

Schema: SuccessEnvelope_TealInstanceCursorListResponse_

successboolean
messagestring
codestring
dataTealInstanceCursorListResponse

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject