Informational health of the environment's connections
GET /v1/connection_health: Informational health of the environment's connections.
GET /v1/connection_health
One ConnectionHealth per connection, in the connection list’s order (newest first), so a dashboard reads the environment’s health in one call instead of one per connection. organization narrows it to one organization’s connections.
- Scope
connections:read- Auth
- Secret key (
sk_…) - Since
- 1.0
Query parameters
Section titled “Query parameters”limitintegermin 1 · max 100 · default
20
Cursor from next_cursor.afterstringorganizationstring
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Responses
Section titled “Responses”- 200 A page of results. ConnectionHealthList
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X GET \ "https://api.ohauthcat.com/v1/connection_health" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY"const response = await fetch("https://api.ohauthcat.com/v1/connection_health", { method: "GET", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, },});const data = await response.json();import osimport requests
response = requests.get( "https://api.ohauthcat.com/v1/connection_health", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},)data = response.json(){ "object": "list", "data": [ { "object": "connection_health", "connection": "conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "observed_at": "2026-01-15T09:30:00Z", "window_start": "2026-01-15T09:30:00Z", "score": 0, "status": "healthy", "factors": [ { "name": "signins", "score": 0, "status": "observed" } ] } ], "has_more": true, "next_cursor": "cur_01J9Z3K5V7W8X9Y0Z1A2B3C4D5"}