---
title: "Get Connection Health"
method: GET
path: "/api/psa/{team_key}/connection/{connection_key}/health"
tags: ["psa"]
---

# Get Connection Health

`GET /api/psa/{team_key}/connection/{connection_key}/health`

## Request

- Base URL: `https://api.superit.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.superit.ai/api/psa/{team_key}/connection/{connection_key}/health`
- Auth: HTTP bearer

Sync state the chat agent reads, for panels that show it live.

## Path parameters

- `team_key` string, required
- `connection_key` string, required

## Response `200`

Successful Response

- ConnectionHealth
  - `key` string, required
  - `name` string, required
  - `psaType` string, required
  - `active` boolean, required
  - `primary` boolean, required
  - `referenceData` ReferenceDataHealth, required
    - `status` string, nullable, required
    - `lastAttemptAt` string, date-time, nullable, required
    - `syncedAt` string, date-time, nullable, required
    - `error` string, nullable, required
  - `catalogue` CatalogueHealth, required
    - `status` string, nullable, required
    - `syncedAt` string, date-time, nullable, required
    - `error` string, nullable, required
    - `companies` integer, required
    - `activeLinks` integer, required
  - `ticketPoll` TicketPollHealth, required
    - `lastPolledAt` string, date-time, nullable, required
    - `error` string, nullable, required
  - `links` LinkHealth[], required
    - `managedTeamKey` string, required
    - `managedTeamName` string, nullable
    - `active` boolean, required
    - `entitySyncStarted` string, date-time, nullable, required
    - `entitySyncCompleted` string, date-time, nullable, required
    - `entitySyncError` string, nullable, required
    - `initialTicketSyncStarted` string, date-time, nullable, required
    - `initialTicketSyncCompleted` string, date-time, nullable, required
    - `initialTicketSyncCount` integer, nullable, required
    - `initialTicketSyncError` string, nullable, required
    - `syncProgress` object, nullable, required

## Other responses

- `400`: Invalid input
- `401`: Not authenticated
- `403`: Forbidden
- `404`: Not found
- `405`: Method not allowed
- `409`: Conflict
- `422`: Validation Error

---

[API](https://skmtc.dev/superit/apis/super-it-api.md) - [All operations](https://skmtc.dev/superit/apis/super-it-api/llms.txt) - [OpenAPI document](https://skmtc.dev/superit/apis/super-it-api/revisions/4944d556c2bb?raw)