Get recurring template

GET /api/v1/recurring/{template_id}

Get a specific recurring template by ID.

Operation ID: get_recurring_template_api_v1_recurring__template_id__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

Path

template_id string required

Responses

200 Successful Response

Schema: RecurringTemplateResponse

id string required
business_id string required
name string required
recurrence_type RecurrenceTypeEnum-Output requiredRecurrenceTypeEnum-Output
status RecurringStatusEnum requiredRecurringStatusEnum
frequency FrequencyEnum requiredFrequencyEnum
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

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

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

Code samples

GET /api/v1/recurring/{template_id}

bash

curl -X GET 'https://api.ondayzero.com/api/v1/recurring/{template_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

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

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/{template_id}", headers=headers)
data = response.json()