The connection

The fields of a connection — your company's link to one partner — as the connection endpoints and connection events return it.

A connection is your company's link to one partner. It is created when you claim the code the partner generated, and it carries what the partner allows you to do. See Connecting partners.

Attributes

idstringrequired: The connection's ID.
partnerIdstringrequired: The partner's Localoy ID. Send it as X-Localoy-Partner-Id on every call for this partner; webhooks carry it as partnerId.
partner.namestring | nullrequired: The partner's business name, to show in your product. null when it is not available.
statusstringrequired: ACTIVE, PAUSED or REVOKED. See Connection statuses.
scopesstring[]required: The effective scopes — those the partner granted that Localoy still allows you. What you can do for the partner now.
grantedScopesstring[]required: The scopes the partner granted: any of REGISTRATION, UPDATE, INVENTORY, PAYMENT and BOOKINGS.
modulesstring[]required: The modules you serve: any of EVENT, DINING and ACTIVITY. See Modules.
connectedAtstringrequired: When you claimed the code, ISO 8601 UTC.
scopesGrantedAtstringrequired: When the partner last set its scopes.
pausedAtstring | nullrequired: When the partner paused you, or null.
revokedAtstring | nullrequired: When the partner disconnected you, or null.
lastCallAtstring | nullrequired: When you last made a call for this partner, or null.

The connection

{
  "id": "cm7c0nn3ct10n00000000001",
  "partnerId": "cm1partnerid000000000000001",
  "partner": { "name": "Sultan's Dine" },
  "status": "ACTIVE",
  "scopes": ["REGISTRATION", "UPDATE", "INVENTORY", "BOOKINGS"],
  "grantedScopes": ["REGISTRATION", "UPDATE", "INVENTORY", "BOOKINGS"],
  "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"
}