Get connections list

Retrieves the list of LinkedIn connections for the authenticated user. Returns connection details including name, headline, vanity name, and connected date. Supports pagination via startIndex and limit parameters. Paginating clients must stop on `endOfList: true`, not on an empty array — an empty page with HTTP 502 / `code: CONNECTIONS_UNAVAILABLE` means LinkedIn temporarily returned nothing and the request should be retried.

GET/connections

Authentication requiredUser

Code Examples

curl -X GET 'https://api.connectsafely.ai/linkedin/connections' \
  -H 'Authorization: Bearer <your_api_key>'

Retrieves the list of LinkedIn connections for the authenticated user. Returns connection details including name, headline, vanity name, and connected date. Supports pagination via startIndex and limit parameters. Paginating clients must stop on endOfList: true, not on an empty array — an empty page with HTTP 502 / code: CONNECTIONS_UNAVAILABLE means LinkedIn temporarily returned nothing and the request should be retried.

Parameters

Name	In	Required	Type	Description
`accountId`	query	No	string	LinkedIn account ID to use. If not provided, uses the default account.
`startIndex`	query	No	number	Starting index for pagination (0-indexed). Use to fetch additional connections.
`limit`	query	No	number	Number of connections to return (max 12).
`sortBy`	query	No	string	Sort order for connections. Options: recentlyAdded (default), firstName, lastName.

Request Body

No request body.

Responses

Status	Description
200	Connections list retrieved successfully
401	Unauthorized - invalid or missing authentication
500	Server error while fetching connections
502	Connections list temporarily unavailable — LinkedIn returned no connections at this startIndex even though the account has more. Retryable; do NOT treat as the end of the list.

200 Response Parameters

Name	Type	Description
`success`	boolean
`connections`	array
`endOfList`	boolean	true only when this page is empty AND the account has no connections beyond startIndex (verified against the exact connection count). Paginate until this is true — never stop on an empty array alone.
`startIndex`	number	Starting index used for this request
`limit`	number	Number of items requested
`sortBy`	string	Sort order applied to connections
`accountId`	string	LinkedIn account ID used for the request

200 Example

{
  "success": true,
  "endOfList": false,
  "connections": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "vanityName": "johndoe",
      "headline": "CEO | Entrepreneur | Tech Founder",
      "connectedDate": "Connected on Feb 15, 2024",
      "profileUrl": "https://www.linkedin.com/in/johndoe/"
    },
    {
      "firstName": "Jane",
      "lastName": "Smith",
      "vanityName": "janesmith",
      "headline": "VP of Engineering at TechCorp",
      "connectedDate": "Connected on Jan 10, 2024",
      "profileUrl": "https://www.linkedin.com/in/janesmith/"
    }
  ],
  "startIndex": 0,
  "limit": 10,
  "sortBy": "recentlyAdded",
  "accountId": "696ce9e780e0483585e4e553"
}

401 Response Parameters

Name	Type	Description
`error`	string

401 Example

{
  "error": "example_value"
}

500 Response Parameters

Name	Type	Description
`error`	string

500 Example

{
  "error": "example_value"
}

502 Example

{
  "success": false,
  "code": "CONNECTIONS_UNAVAILABLE",
  "error": "Connections list unavailable: LinkedIn returned no connections at startIndex 3324 but the account has 3419. Retry later — do NOT treat this as the end of the list.",
  "startIndex": 3324,
  "connectionCount": 3419,
  "accountId": "696ce9e780e0483585e4e553"
}

Code Examples

On this page