Get the refresh schedule

GET/api/v1/dashboards/{dashboard_id}/schedule

Return this dashboard's refresh schedule, including its last/next run times and the error from the most recent failed run. Responds with schedule: null when no schedule is configured — absence of a schedule is a normal state, not a 404.

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

dashboard_idstringrequired

Responses

200Successful Response

Schema: SuccessEnvelope_DashboardScheduleEnvelope_

successboolean
messagestring
codestring
dataDashboardScheduleEnvelope

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/dashboards/{dashboard_id}/schedule

bash

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