Skip to content

Get integration health

GET
/v1/status
curl --request GET \
  --url https://api.inboxcnx.com/v1/status \
  --header 'Authorization: Bearer <token>'

Returns the integration health of every application in the caller’s organization, so you can spot a broken mailbox or failing webhooks early. Reports, per application, how many mailbox connections and grants exist and in which state, when each last synced, and how the last 24 hours of webhook deliveries went.

Unlike every other /v1 endpoint this one is organization-wide: a key of one application sees the ids and health of the others, so one key covers them all. It reports ids and counts only: never mailbox addresses, end-user ids, webhook targets or message contents.

No scope required. A grant token gets 403 grant_scoped_credential.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
applicationId

Narrow the answer to one application. An id belonging to another organization is invisible and yields nothing.

string format: uuid

Narrow the answer to one application. An id belonging to another organization is invisible and yields nothing.

Responses

Section titled “Responses”

200

Section titled “200”

One entry per live application, oldest first

Media typeapplication/json
object
data
required
Array<object>
object
id
required
string
mode
required
string
Allowed values: direct whitelabel
webhookConfigured
required
boolean
connections
required
object
total
required
integer
byStatus
required
object
initiated
required
integer
active
required
integer
error
required
integer
deleted
required
integer
health
required
object
ok
required
integer
degraded
required
integer
down
required
integer
error
required
integer
grants
required
object
total
required
integer
byStatus
required
object
pending
required
integer
active
required
integer
revoked
required
integer
lastSyncedAt
required
string | null
deliveries24h
required
object
total
required
integer
failed
required
integer

Example 

{
  "data": [
    {
      "id": "a3c1e8f2-4b7d-4e9a-9f10-6d2b8c5e7a41",
      "mode": "direct",
      "webhookConfigured": true,
      "connections": {
        "total": 3,
        "byStatus": {
          "initiated": 0,
          "active": 2,
          "error": 1,
          "deleted": 0
        },
        "health": {
          "ok": 2,
          "degraded": 0,
          "down": 0,
          "error": 1
        }
      },
      "grants": {
        "total": 3,
        "byStatus": {
          "pending": 0,
          "active": 3,
          "revoked": 0
        }
      },
      "lastSyncedAt": "2026-10-23T07:58:12.000Z",
      "deliveries24h": {
        "total": 412,
        "failed": 2
      }
    }
  ]
}

403

Section titled “403”

The credential is grant-scoped and may not read organization-wide health

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}