# GET /api/v1/businesses/teal-instances

> Get Teal instances

- **Tag:** businesses
- **Operation ID:** `get_teal_instances_api_v1_businesses_teal_instances_get`

## Description

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')

## Authentication

Bearer token in `Authorization` header.
Required header: `x-business-id: <business uuid>`.

## Parameters

- `enriched` (query, boolean, optional) — Whether to enrich instances with business information
- `cursor` (query, string, optional) — Cursor for pagination
- `limit` (query, integer, optional) — Pagination limit
- `direction` (query, string, optional) — Pagination direction: 'next' or 'prev'
- `include_total_count` (query, boolean, optional) — Whether to include total count (expensive - avoid if possible)
- `sort_by` (query, string, optional) — Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.
- `descending` (query, boolean, optional) — Sort direction: true for descending (newest/largest first), false for ascending

## Responses

### 200 — Successful Response

Schema: `TealInstanceCursorListResponse`

- `items` (array · TealInstanceResponse · required) → `TealInstanceResponse` — List of items
  - `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`
  - `loc` (array · string | integer · required)
  - `msg` (string · required)
  - `type` (string · required)
  - `input` (object)
  - `ctx` (object)

## Code samples

### cURL

```bash
curl -X GET 'https://api.ondayzero.com/api/v1/businesses/teal-instances' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'
```

### JavaScript

```javascript
const response = await fetch('https://api.ondayzero.com/api/v1/businesses/teal-instances', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();
```

### Python

```python
import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/businesses/teal-instances", headers=headers)
data = response.json()
```

## See also

- HTML version: https://www.ondayzero.com/docs/reference/businesses/get-teal-instances
- OpenAPI slice: https://www.ondayzero.com/docs/reference/businesses/get-teal-instances/openapi.json
- Other endpoints in **businesses**: https://www.ondayzero.com/docs/reference/businesses