Skip to content

Commit f8873ad

Browse files
docs: Add GetCompanyFollowers endpoint documentation (#38)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Adil <[email protected]>
1 parent 92a99f6 commit f8873ad

File tree

1 file changed

+84
-0
lines changed

1 file changed

+84
-0
lines changed

source/includes/_enrichment.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -879,3 +879,87 @@ Parameter | Description
879879
--------- | -----------
880880
start | Starting offset for pagination (default: 0)
881881
pagination_token | Token for paginated results
882+
883+
## Company Followers
884+
885+
<aside class="notice">
886+
Uses 1 Standard Credit.
887+
</aside>
888+
889+
This endpoint retrieves followers for a specific LinkedIn company organisation.
890+
891+
### HTTP Request
892+
893+
`GET https://api.lix-it.com/v1/organisations/followers`
894+
895+
### URL Parameters
896+
897+
#### Required parameters
898+
899+
Parameter | Description
900+
--------- | -----------
901+
profile_link | The LinkedIn organisation profile URL (either standard LinkedIn URL or Sales Navigator URL)
902+
viewer_id | The LinkedIn ID of the account you would like to view this data as
903+
904+
#### Optional parameters
905+
906+
Parameter | Description
907+
--------- | -----------
908+
start | Starting offset for pagination (default: 0)
909+
count | Number of followers to return (default: 100)
910+
911+
```python
912+
import requests
913+
914+
url = "https://api.lix-it.com/v1/organisations/followers?profile_link=https://www.linkedin.com/company/example-corp&viewer_id=ACoAAAXQSFkBYBAvJOtLzKQz7X0qXjByqI9m7Tg"
915+
916+
payload={}
917+
headers = {
918+
'Authorization': [lixApiKey]
919+
}
920+
921+
response = requests.request("GET", url, headers=headers, data=payload)
922+
923+
print(response.json())
924+
```
925+
926+
```shell
927+
curl "https://api.lix-it.com/v1/organisations/followers?profile_link=https://www.linkedin.com/company/example-corp&viewer_id=ACoAAAXQSFkBYBAvJOtLzKQz7X0qXjByqI9m7Tg" \
928+
-H "Authorization: lixApiKey"
929+
```
930+
931+
```json
932+
{
933+
"followers": [
934+
{
935+
"publicIdentifier": "john-doe-example",
936+
"firstName": "John",
937+
"lastName": "Doe",
938+
"profilePictureUrl": "https://media.licdn.com/dms/image/example/profile-photo.jpg",
939+
"entityUrn": "urn:li:fsd_profile:ACoAAAXQSFkBYBAvJOtLzKQz7X0qXjByqI9m7Tg",
940+
"headline": "Software Engineer at Tech Innovations",
941+
"followedAt": "July 2024",
942+
"memberDistance": "DISTANCE_2"
943+
},
944+
{
945+
"publicIdentifier": "jane-smith-example",
946+
"firstName": "Jane",
947+
"lastName": "Smith",
948+
"profilePictureUrl": "https://media.licdn.com/dms/image/example/profile-photo-2.jpg",
949+
"entityUrn": "urn:li:fsd_profile:ACoAAABcDEFgBhABCDEFGHIJKLMNOPQRSTUVWXYZ",
950+
"headline": "Product Manager at Innovation Labs",
951+
"followedAt": "June 2024",
952+
"memberDistance": "DISTANCE_1"
953+
}
954+
],
955+
"paging": {
956+
"total": 1250,
957+
"count": 2,
958+
"start": 0
959+
}
960+
}
961+
```
962+
963+
<aside class="notice">
964+
Please be aware if some data points do not exist, these will be returned as null.
965+
</aside>

0 commit comments

Comments
 (0)