Skip to content

Preview what a connection transfer would touch

GET /connection/{id}/transfer-preview

Previews what `POST /connection/{id}/transfer` would break, before anything is written, so you can show the consequence while the decision is still open. It is a summary, not a list: exact counts plus at most five named toolboxes, breaking ones first, so it takes no `limit` or `cursor`. Gated on exactly what the transfer itself is gated on, so it never advertises something that would 403.

Path Parameters

idstring
required·

Connection id (conn_…).

Response Body

affected_toolbox_countinteger

Exact number of toolboxes with an entry pinned to this connection.

affected_toolboxesobject[]

At most five, breaking ones first. A preview — read the counts, not this length.

breaks_without_retained_accessboolean

The outgoing owner pinned at least one of this toolbox's entries on the connection.

kindstring
Possible values:
toolbox
toolbox_idstring
toolbox_namestring
broken_delegation_countinteger

Exact number of the above that the CALLER pinned, and so the number at risk if they end up below use. Not narrowed by keeps_access_without_retaining — read the two together.

keeps_access_without_retainingboolean

The caller already reaches this connection through a grant of their own (org-wide, or a team they are in), so handing it over costs them nothing even without retain_access and nothing they pinned breaks. Computed server-side because access: "owner" outranks and hides whatever grant is underneath it — a client cannot derive this.

curl -X GET 'https://api.elaichi.ai/connection/<id>/transfer-preview' \
  -H 'Authorization: Bearer $ELAICHI_API_TOKEN' \
  -H 'Content-Type: application/json'
const response = await fetch('https://api.elaichi.ai/connection/<id>/transfer-preview', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer ' + process.env.ELAICHI_API_TOKEN,
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import os
import requests

url = "https://api.elaichi.ai/connection/<id>/transfer-preview"
headers = {
    "Authorization": f"Bearer {os.environ['ELAICHI_API_TOKEN']}",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())