Retrieve a connection

Read your connection with one partner — its status, effective scopes and modules.

GET{BASE_URL}/connections/{partnerId}

Returns your connection with one partner. Requires a provider key; the partner header is ignored — the partner is named in the path. Use it to check a connection's status and scopes before a sync, or to refresh your copy after a connection.* event.

It returns the latest connection you claimed with that partner, whatever its status. After a disconnect you get it with status REVOKED, which tells an ended connection from one that never existed.

Path parameters

partnerIdstringrequired: The partner's Localoy ID, the connection's partnerId.

Response

dataobjectrequired: The connection.

Status codes#

Status	Code	Meaning
`200`	—	Success.
`403`	`provider_key_required`	A partner key made the call.
`404`	`connection_not_found`	You never claimed a connection with this partner. A code it generated that you have not claimed does not count.

curl "$LOCALOY_BASE_URL/connections/$LOCALOY_PARTNER_ID" \
  -H "Authorization: Bearer $LOCALOY_PROVIDER_KEY"

Response · 200

{
  "success": true,
  "data": {
    "id": "cm7c0nn3ct10n00000000001",
    "partnerId": "cm1partnerid000000000000001",
    "partner": { "name": "Sultan's Dine" },
    "status": "ACTIVE",
    "scopes": ["REGISTRATION", "UPDATE", "INVENTORY"],
    "grantedScopes": ["REGISTRATION", "UPDATE", "INVENTORY"],
    "modules": ["EVENT", "DINING"],
    "connectedAt": "2026-09-27T09:14:02.518Z",
    "scopesGrantedAt": "2026-09-27T09:12:40.107Z",
    "pausedAt": null,
    "revokedAt": null,
    "lastCallAt": "2026-09-27T11:02:19.874Z"
  }
}