POST
/
v1
/
network
/
invitations
curl --request POST \
  --url https://api.linkupapi.com/v1/network/invitations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "total_results": 123,
  "country": "<string>",
  "login_token": "<string>"
}'
{
  "status": "success",
  "data": {
    "total_results": 1,
    "invitations": [
      {
        "name": "John Doe",
        "profile_url": "https://www.linkedin.com/in/johndoe/",
        "profile_picture": "https://media.licdn.com/dms/image/v2/example.jpg",
        "subtitle": "Software Engineer at Tech Company",
        "sent_time": "2 days ago",
        "message": "I'd like to join your network!",
        "invitation_id": "2906418534",
        "shared_secret": "xyz123",
        "shared_connections": "5 shared connections",
        "invitation_state": "PENDING",
        "entity_urn": "urn:li:invitation:2906418534"
      }
    ]
  }
}

Get a list of pending connection invitations with detailed information about each invitation and inviter.

Credit Usage: 1 credit per 10 results (or fraction thereof). For example:

  • 1-10 results = 1 credit
  • 11-20 results = 2 credits
  • 300 results = 30 credits

​
Header Parameters

​
x-api-key
string
required

Your API key

​
Body Parameters

​
total_results
integer
default:"10"

Number of invitations to retrieve

​
country
string
default:"FR"

Country code for proxy selection. Available: (US,UK,FR)

​
login_token
string
required

LinkedIn authentication cookie obtained from the login/verify process

​
Response

​
status
string

Request status (success/error)

​
data
object
{
  "status": "success",
  "data": {
    "total_results": 1,
    "invitations": [
      {
        "name": "John Doe",
        "profile_url": "https://www.linkedin.com/in/johndoe/",
        "profile_picture": "https://media.licdn.com/dms/image/v2/example.jpg",
        "subtitle": "Software Engineer at Tech Company",
        "sent_time": "2 days ago",
        "message": "I'd like to join your network!",
        "invitation_id": "2906418534",
        "shared_secret": "xyz123",
        "shared_connections": "5 shared connections",
        "invitation_state": "PENDING",
        "entity_urn": "urn:li:invitation:2906418534"
      }
    ]
  }
}

​
Notes

  • The shared_secret and entity_urn are required for accepting invitations using the /v1/network/accept-invitation endpoint
  • The profile picture URL may be null if not available
  • The message field may be empty if no custom message was included
  • Shared connections information may be null if there are no mutual connections
  • Retrieved invitations are sorted by most recent first