Read LinkedIn network
Read connections, followers or following of a connected LinkedIn account, and find connections by name.
Endpoint
Parameters
| Name | Type | Required | Note |
|---|---|---|---|
| relationshipstring · required | string | required | Connections are first-degree mutual relations; followers follow this owner; following are accounts this owner follows. These are distinct lists. One of: |
| limitnumber · optional | number | optional | Maximum items in this single page (1–100, default 20). A short page never proves full-network completion. Default: |
| cursorstring · optional | string | optional | Connections only: nextCursor from the previous result for the same selected account, relationship and search. |
| offsetnumber · optional | number | optional | Followers/following only: nextOffset from the previous result; start at zero. Continue even after a short page when supplied. |
| searchstring · optional | string | optional | Connections only: provider-supported name filter. No job/company/location or follower/following search. |
| accountIdstring · optional | string | optional | Connected LinkedIn account from connector-list-accounts: exact name, handle, profile link or account ID. Omit only for a host pin or one unambiguous available account. |
Response schema
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"success",
"status",
"accountId",
"ownerId",
"relationship",
"items",
"returnedCount",
"limit",
"nextCursor",
"nextOffset",
"hasMore",
"totalAvailable",
"networkComplete",
"message"
],
"properties": {
"meta": {
"type": "object",
"required": [
"actualCreditCost"
],
"properties": {
"actualCreditCost": {
"type": "number",
"minimum": 0
}
},
"additionalProperties": false
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"providerId",
"displayName",
"type"
],
"properties": {
"type": {
"enum": [
"individual",
"organization",
"other"
],
"type": "string"
},
"headline": {
"type": "string"
},
"profileUrl": {
"type": "string"
},
"providerId": {
"type": "string",
"minLength": 1
},
"displayName": {
"type": "string",
"minLength": 1
},
"publicIdentifier": {
"type": "string"
}
},
"additionalProperties": false
}
},
"limit": {
"type": "integer"
},
"status": {
"enum": [
"page",
"empty",
"incomplete",
"unavailable"
],
"type": "string"
},
"hasMore": {
"type": [
"boolean",
"null"
]
},
"message": {
"type": "string"
},
"ownerId": {
"type": "string"
},
"success": {
"type": "boolean"
},
"accountId": {
"type": "string"
},
"nextCursor": {
"anyOf": [
{
"type": "string",
"maxLength": 4096
},
{
"type": "null"
}
]
},
"nextOffset": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"relationship": {
"enum": [
"connections",
"followers",
"following"
],
"type": "string"
},
"returnedCount": {
"type": "integer",
"minimum": 0
},
"totalAvailable": {
"type": [
"number",
"null"
]
},
"networkComplete": {
"type": "boolean",
"const": false
}
},
"additionalProperties": false
}