# GET /api/v1/recurring/invoices

> List recurring invoice templates

- **Tag:** recurring
- **Operation ID:** `list_recurring_invoice_templates_api_v1_recurring_invoices_get`

## Description

List all recurring invoice templates for the business.

## Authentication

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

## Parameters

- `status` (query, RecurringStatusEnum, optional) — Filter by status
- `customer_id` (query, string, optional) — Filter by customer ID
- `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: `RecurringTemplateListResponse`

- `items` (array · RecurringTemplateResponse · required) → `RecurringTemplateResponse`
  - `id` (string · required)
  - `business_id` (string · required)
  - `name` (string · required)
  - `recurrence_type` (RecurrenceTypeEnum-Output · required) → `RecurrenceTypeEnum-Output`
  - `status` (RecurringStatusEnum · required) → `RecurringStatusEnum`
  - `frequency` (FrequencyEnum · required) → `FrequencyEnum`
  - `start_date` (string · date · required)
  - `end_date` (string · date)
  - `next_occurrence` (string · date · required)
  - `last_generated` (string · date-time)
  - `day_of_month` (integer)
  - `day_of_week` (integer)
  - `max_occurrences` (integer)
  - `occurrences_generated` (integer · required)
  - `template_data` (object · required)
  - `days_until_due` (integer · required)
  - `auto_send` (boolean · required)
  - `notes` (string)
  - `customer` (CustomerSummary)
  - `vendor` (VendorSummary)
  - `created_at` (string · date-time · required)
  - `updated_at` (string · date-time · required)
  - `amount_in_dollars` (number)
  - `frequency_display` (string · required)
  - `days_until_next` (integer)
  - `is_due` (boolean · required)
  - `should_generate` (boolean · required)
- `total_count` (integer)
- `next_cursor` (string)
- `prev_cursor` (string)
- `has_next` (boolean)
- `has_prev` (boolean)

### 401 — Unauthorized - Authentication required

### 403 — Forbidden - Insufficient permissions

### 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/recurring/invoices' \
  -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/recurring/invoices', {
  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/recurring/invoices", headers=headers)
data = response.json()
```

## See also

- HTML version: https://www.ondayzero.com/docs/reference/recurring/list-recurring-invoice-templates
- OpenAPI slice: https://www.ondayzero.com/docs/reference/recurring/list-recurring-invoice-templates/openapi.json
- Other endpoints in **recurring**: https://www.ondayzero.com/docs/reference/recurring