Check Invitation Status

curl --request POST \
  --url https://api.linkupapi.com/v2/network \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "account_id": "<string>",
  "action": "<string>",
  "params": {
    "profile_url": "<string>"
  }
}
'

import requests

url = "https://api.linkupapi.com/v2/network"

payload = {
    "account_id": "<string>",
    "action": "<string>",
    "params": { "profile_url": "<string>" }
}
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_id: '<string>', action: '<string>', params: {profile_url: '<string>'}})
};

fetch('https://api.linkupapi.com/v2/network', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.linkupapi.com/v2/network",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => '<string>',
    'action' => '<string>',
    'params' => [
        'profile_url' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.linkupapi.com/v2/network"

	payload := strings.NewReader("{\n  \"account_id\": \"<string>\",\n  \"action\": \"<string>\",\n  \"params\": {\n    \"profile_url\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.linkupapi.com/v2/network")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"<string>\",\n  \"action\": \"<string>\",\n  \"params\": {\n    \"profile_url\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.linkupapi.com/v2/network")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"<string>\",\n  \"action\": \"<string>\",\n  \"params\": {\n    \"profile_url\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "invitation_state": "ACCEPTED",
    "invitation_type": "CONNECTED",
    "invitation_id": null,
    "member_distance": 1,
    "message": "You are connected with this person"
  },
  "metadata": {
    "action": "check_invitation",
    "account_id": "your-account-id",
    "credits_consumed": 1,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}

{
  "success": true,
  "data": {
    "invitation_state": "PENDING",
    "invitation_type": "SENT",
    "invitation_id": 7453486530700017665,
    "invitation_id_str": "7453486530700017665",
    "member_distance": 2,
    "message": "Invitation pending"
  },
  "metadata": {
    "action": "check_invitation",
    "account_id": "your-account-id",
    "credits_consumed": 1,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}

{
  "success": true,
  "data": {
    "invitation_state": "NO_INVITATION",
    "invitation_type": null,
    "invitation_id": null,
    "member_distance": 3,
    "message": "No invitation found"
  },
  "metadata": {
    "action": "check_invitation",
    "account_id": "your-account-id",
    "credits_consumed": 1,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Invalid LinkedIn URL format"
  },
  "metadata": {
    "action": "check_invitation",
    "credits_consumed": 0,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}

POST

network

Check Invitation Status

curl --request POST \
  --url https://api.linkupapi.com/v2/network \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "account_id": "<string>",
  "action": "<string>",
  "params": {
    "profile_url": "<string>"
  }
}
'

import requests

url = "https://api.linkupapi.com/v2/network"

payload = {
    "account_id": "<string>",
    "action": "<string>",
    "params": { "profile_url": "<string>" }
}
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_id: '<string>', action: '<string>', params: {profile_url: '<string>'}})
};

fetch('https://api.linkupapi.com/v2/network', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.linkupapi.com/v2/network",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => '<string>',
    'action' => '<string>',
    'params' => [
        'profile_url' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.linkupapi.com/v2/network"

	payload := strings.NewReader("{\n  \"account_id\": \"<string>\",\n  \"action\": \"<string>\",\n  \"params\": {\n    \"profile_url\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.linkupapi.com/v2/network")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"<string>\",\n  \"action\": \"<string>\",\n  \"params\": {\n    \"profile_url\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.linkupapi.com/v2/network")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"<string>\",\n  \"action\": \"<string>\",\n  \"params\": {\n    \"profile_url\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "invitation_state": "ACCEPTED",
    "invitation_type": "CONNECTED",
    "invitation_id": null,
    "member_distance": 1,
    "message": "You are connected with this person"
  },
  "metadata": {
    "action": "check_invitation",
    "account_id": "your-account-id",
    "credits_consumed": 1,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}

{
  "success": true,
  "data": {
    "invitation_state": "PENDING",
    "invitation_type": "SENT",
    "invitation_id": 7453486530700017665,
    "invitation_id_str": "7453486530700017665",
    "member_distance": 2,
    "message": "Invitation pending"
  },
  "metadata": {
    "action": "check_invitation",
    "account_id": "your-account-id",
    "credits_consumed": 1,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}

{
  "success": true,
  "data": {
    "invitation_state": "NO_INVITATION",
    "invitation_type": null,
    "invitation_id": null,
    "member_distance": 3,
    "message": "No invitation found"
  },
  "metadata": {
    "action": "check_invitation",
    "account_id": "your-account-id",
    "credits_consumed": 1,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Invalid LinkedIn URL format"
  },
  "metadata": {
    "action": "check_invitation",
    "credits_consumed": 0,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}

Overview

Returns the current connection / invitation status with a specific user. Useful to know whether you’re already connected, have a pending sent or received invitation, or have no relationship yet.

This endpoint consumes 1 credit per request. Ignore this if you’re on per-seat pricing: usage is unlimited.

Request

string

required

Your API key for authentication.

string

required

The unique identifier of the account to use.

string

required

Must be "check_invitation".

object

required

Show params properties

string

required

URL of the profile on the connected platform of the person to check.

Response

boolean

Indicates whether the request was successful.

object

Show data properties

string

One of:

"ACCEPTED" — you are already connected with this person
"PENDING" — an invitation is pending (sent or received)
"NO_INVITATION" — no invitation has been exchanged

string

Direction of the invitation when applicable. One of:

"CONNECTED" (when invitation_state is ACCEPTED)
"SENT" (you sent the invitation)
"RECEIVED" (the other person sent it)
null when invitation_state is NO_INVITATION

integer

Numeric ID of the invitation when one exists (use it with the withdraw action). null otherwise.

string

Same ID as a string. Use this one in JavaScript: a 19-digit number loses precision there.

integer

Network distance to the target profile (1, 2, 3, …).

string

Human-readable description of the state.

object

Show metadata properties

string

The action that was performed ("check_invitation").

string

The account ID used for the request.

integer

Number of credits consumed (1).

string

ISO 8601 timestamp of the response.

{
  "success": true,
  "data": {
    "invitation_state": "ACCEPTED",
    "invitation_type": "CONNECTED",
    "invitation_id": null,
    "member_distance": 1,
    "message": "You are connected with this person"
  },
  "metadata": {
    "action": "check_invitation",
    "account_id": "your-account-id",
    "credits_consumed": 1,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}

{
  "success": true,
  "data": {
    "invitation_state": "PENDING",
    "invitation_type": "SENT",
    "invitation_id": 7453486530700017665,
    "invitation_id_str": "7453486530700017665",
    "member_distance": 2,
    "message": "Invitation pending"
  },
  "metadata": {
    "action": "check_invitation",
    "account_id": "your-account-id",
    "credits_consumed": 1,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}

{
  "success": true,
  "data": {
    "invitation_state": "NO_INVITATION",
    "invitation_type": null,
    "invitation_id": null,
    "member_distance": 3,
    "message": "No invitation found"
  },
  "metadata": {
    "action": "check_invitation",
    "account_id": "your-account-id",
    "credits_consumed": 1,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Invalid LinkedIn URL format"
  },
  "metadata": {
    "action": "check_invitation",
    "credits_consumed": 0,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}

Getting Started

Accounts

Profiles

Messaging

Network

Content

Recruiting

Credits

Logs

Email Enrichment

Webhooks (Real-Time)

Check Invitation Status

Overview

Request

Response