get
https://connect.agendapro.com/v3/provider_breaks
This endpoint returns the breaks (blocked time) of one or more providers, ordered by start.
Important Notes
provider_idis required. Send several providers separated by commas (provider_id=12,34).- If any requested provider belongs to another company, the whole request responds
404. start_dateandend_datefilter by day (YYYY-MM-DD). A break is included when it overlaps the range, even partially.editableisfalsefor breaks synced from Google Calendar: they cannot be updated or deleted through the API.- Dates follow the local-time convention described in Dates and times.
- Errors from platform-services use legacy single-key codes (e.g.
provider_not_found,google_event_break), withoutdetail; errors from Connect itself (auth, scope, rate limit) keep{error, detail}.
Errors Dictionary
| Status | Error | Detail | Description |
|---|---|---|---|
| 400 | missing_service_provider_id | provider_id is missing. | |
| 400 | invalid_start_date | start_date is not a valid date. | |
| 400 | invalid_end_date | end_date is not a valid date. | |
| 401 | unauthorized | invalid_api_key | Missing or invalid Bearer token. |
| 401 | unauthorized | api_config_inactive | API access is inactive for this company. |
| 403 | forbidden | scope_denied | API key lacks provider_breaks:read scope. |
| 404 | provider_not_found | A requested provider does not exist or belongs to another company. | |
| 429 | rate_limited | burst_limit_exceeded | Per-minute request limit exceeded. |
| 429 | rate_limited | daily_quota_exceeded | Daily request quota exceeded. |
| 502 | upstream_unavailable | The upstream service is unavailable. |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…