Checking connection statuses
This endpoint allows you to check connection statuses between your LinkedIn account and specified people.
POST https://api.linkedapi.io/account/connections.checkStatus
Body
{
"people": [
"https://www.linkedin.com/in/person1",
"https://www.linkedin.com/in/person2"
]
}
people
– LinkedIn URLs of people you want to check a connection status with.
Response
- If all checks are successful:
{
"status": "complete",
"completion": [
{
"person": "https://www.linkedin.com/in/person1",
"result": {
"success": true,
"data": {
"connectionStatus": "pending"
}
}
},
{
"person": "https://www.linkedin.com/in/person2",
"result": {
"success": true,
"data": {
"connectionStatus": "connected"
}
}
}
]
}
connectionStatus
– enum with the following possible values:connected
– your account is connected with the person.notConnected
– your account is not connected with the person.pending
– your account has a pending connection request to the person.
- If some checks are unsuccessful:
{
"status": "complete",
"completion": [
{
"person": "https://www.linkedin.com/in/person1",
"result": {
"success": true,
"data": {
"connectionStatus": "pending"
}
}
},
{
"person": "https://www.linkedin.com/in/person2",
"result": {
"success": false,
"error": {
"errorType": "personNotFound"
"message": "The provided URL is not an existing LinkedIn person."
}
}
}
]
}
errorType
– enum with the following possible values:personNotFound
– provided URL is not an existing LinkedIn person.
Throughout the documentation, for simplicity, only the request body and final response (when status is
complete
) are shown. Consider possible global errors and result handling options for proper implementation.