Connections

Account connections with other LC accounts

Get connection by ID

Retrieves a connection by its unique identifier, SSO Connection Id, or Invitation Id. This endpoint allows clients to fetch detailed information about a specific connection.

SecurityAPIKey
Request
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the connection to get. This can be a unique identifier, SSO Connection Id, or Invitation Id.

Example: 5fd4371e940df5a34a3888b2
Responses
200

Created

401

Authorization information is missing or invalid.

get/connections/{id}
Request samples 
Response samples 
application/json
{
  • "id": "5fd4371e940df5a34a3888b2",
  • "connected_account": {
    • "id": "5fd4371e940df5a34a3888b2",
    • "sso_id": "5fd4371e940df5a34a3888b2",
    • "name": "Acme Corp"
    },
  • "external_id": "5fd4371e940df5a34a3888b2",
  • "invitation_id": "5fd4371e940df5a34a3888b2",
  • "relationship_type": "seller",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_by": "example@mail.com"
}