Skip to content
Docs

Check a connection again

POST
/api/workspaces/{ws}/connections/{id}/check

Asks the tool who the connection's credential belongs to. Keeps account when it works; sets status: "needs_reconnect" and statusDetail when the tool refuses it. Connections also become needs_reconnect on their own when a tool refuses them while a hire works.

Authorization

session
cookiebetter-auth.session_token<token>

Set by POST /api/auth/sign-in/email.

Path Parameters

ws*string

The workspace id (from GET /api/me).

id*string

The id of what the path names: a hire, a connection, a skill, a shared file, a department, a position, a goal or an approval.

Response Body

The connection.

application/json
Example Request
curl -X POST 'https://app.useroster.work/api/workspaces/string/connections/string/check'
Example Response
{  "id": "8d1e5b2c-0f3a-4e7b-9c6d-1a2b3c4d5e6f",  "kind": "tool",  "type": "github",  "name": "GitHub",  "settings": {},  "secretsSet": [    "token"  ],  "status": "connected",  "statusDetail": null,  "account": "acme-studio",  "checkedAt": "2026-11-03T09:00:00.000Z",  "createdAt": "2026-11-03T09:00:00.000Z"}