---
title: "Get the InboxKit connection state"
method: GET
path: "/mailboxes/inboxkit/connection/"
tags: ["senders"]
---

# Get the InboxKit connection state

`GET /mailboxes/inboxkit/connection/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/mailboxes/inboxkit/connection/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Always 200: not-connected is a state the UI branches on, not an error.

## Response `200`

Successful Response

- InboxkitConnectionStatusSchema: Always-200 connection state. "Not connected" is an ordinary state the dialog branches on, not an error. Answering it with a 404 would be indistinguishable from a transient failure on the client, and a transient failure must never present the connect form over a working connection.
  - `active_import_run` InboxkitImportRunReadSchema
    - `failed_count` integer, required
    - `finished_at` string, date-time, nullable, required
    - `id` string, uuid, required
    - `imported_count` integer, required
    - `requested_count` integer, required
    - `skipped_count` integer, required
    - `started_at` string, date-time, required
    - `status` 'running' | 'succeeded' | 'partial' | 'failed', required: Where one import request stands. RUNNING until every item reaches a terminal state; then SUCCEEDED when everything imported, FAILED when nothing did, PARTIAL for the mix. Status and counts are always derived from items. Three independent paths (the synchronous import, the authorize workflow's import, and its failure branches) finalize items, so denormalized counters would drift.
    - `trigger` 'manual' | 'auto', required: Who asked for the import: a person in the picker, or the hourly sweep.
  - `connected` boolean, required
  - `connection` InboxkitConnectionReadSchema, required
    - `auto_disconnect_enabled` boolean, required
    - `auto_import_enabled` boolean, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `workspace_id` string, required
    - `workspace_name` string, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)
