Sync health overview
curl --request GET \
--url https://breadbox.example.com/api/v1/sync/health \
--header 'X-API-Key: <api-key>'{}Sync
Sync health overview
Fleet-wide sync health (counts of error, pending_reauth, stale connections).
GET
/
api
/
v1
/
sync
/
health
Sync health overview
curl --request GET \
--url https://breadbox.example.com/api/v1/sync/health \
--header 'X-API-Key: <api-key>'{}Documentation Index
Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Breadbox API key with format bb_<base62>. Carries either read_only
or full_access scope. Write endpoints (and a handful of sensitive
reads — /api-keys, /users/{user_id}/login) require full_access;
endpoints that require it are flagged in their description.
Response
200 - application/json
Health summary.
The response is of type object.
⌘I