Skip to content
Dashboard
Theme
Theme

Informational health of the environment's connections

GET /v1/connection_health: Informational health of the environment's connections.

View Markdown

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
  • limit integer

    min 1 · max 100 · default 20

  • after string

    Cursor from next_cursor.

  • organization string

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

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"
Response 200
{
"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"
}