Skip to main content

GET /api/v1/public/prospects//connection-status/

Checks whether a LinkedIn account connected to the workspace is already connected (1st-degree relationship) with the given prospect on LinkedIn. This endpoint queries the underlying LinkedIn provider (Unipile) in real time using the prospect’s LinkedIn profile URL and one of the workspace’s connected LinkedIn accounts. It is intended to be used before sending a connection invitation, so a campaign can decide to skip the invite step when the user is already connected. The same endpoint is also exposed under the JWT-protected path GET /api/v1/prospects/{prospect_id}/connection-status/ for use from the in-app client.
  • Auth: X-API-Key
  • Method: GET

Path Parameters

  • prospect_id (integer, required): ID of the prospect to check.

Query Parameters

  • account_id (integer, optional): ID of a specific LinkedIn ConnectedAccount to use for the check. If omitted, the first active LinkedIn account in the current workspace is used.

Response

Error Responses

Examples

Notes

  • The endpoint performs a live call to the LinkedIn provider on every request and is therefore subject to provider rate limits. It is intended for on-demand checks (for example, immediately before launching a campaign or scheduling an invite), not for bulk polling.
  • “Connected” is defined strictly as a 1st-degree LinkedIn relationship. A pending invitation does not count as connected.
  • The chosen LinkedIn account is the perspective from which the check is made. If a workspace has multiple LinkedIn accounts and the prospect is connected to only one of them, you may get different answers depending on which account is used — pass account_id explicitly when this matters.