Skip to main content
POST
/
v2
/
network
Check Invitation Status
curl --request POST \
  --url https://api.example.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>"
  }
}
'
{
  "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"
  }
}

​
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.

​
Request

​
x-api-key
string
required
Your API key for authentication.
​
account_id
string
required
The unique identifier of the account to use.
​
action
string
required
Must be "check_invitation".
​
params
object
required

​
Response

​
success
boolean
Indicates whether the request was successful.
​
data
object
​
metadata
object
{
  "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"
  }
}