Skip to content

Commit 0899ad7

Browse files
Document Sales Navigator lead and account list exports (#46)
1 parent 475f949 commit 0899ad7

1 file changed

Lines changed: 124 additions & 0 deletions

File tree

source/includes/_linkedin.md

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -501,6 +501,130 @@ print(response.json())
501501
}
502502
```
503503

504+
## Sales Navigator Lead List
505+
506+
This endpoint retrieves a single page of a saved Sales Navigator lead list.
507+
508+
The `viewer_id` parameter is required and must be the LinkedIn ID of the account that owns the list.
509+
510+
To paginate through the list, use the `page` parameter. Each page contains 25 results.
511+
512+
<aside class="notice"> Uses 1 Standard Credit.</aside>
513+
514+
### HTTP Request
515+
`GET https://api.lix-it.com/v1/li/sales/lists/people`
516+
517+
### URL Parameters
518+
519+
#### Required Parameters
520+
521+
Parameter | Description
522+
--------- | -----------
523+
list_id | The ID of the lead list, e.g. `6743848588473139200` for `https://www.linkedin.com/sales/lists/people/6743848588473139200`
524+
viewer_id | The LinkedIn ID of the account that owns the list
525+
526+
#### Optional Parameters
527+
Parameter | Description
528+
--------- | -----------
529+
page | The page of the list to retrieve, starting at 1
530+
sequence_id | A randomly generated string by you that is used to maintain collection settings between requests. [See the section on Sequence IDs for more information](#sequence-ids-amp-pagination)
531+
532+
```shell
533+
curl "https://api.lix-it.com/v1/li/sales/lists/people?list_id=6743848588473139200&viewer_id=ACwAAAd2ql0BjIz3QGaG7pMbLYAJTx3fnRcE8-U&page=1" \
534+
-H "Authorization: lixApiKey"
535+
```
536+
537+
```python
538+
import requests
539+
540+
url = "https://api.lix-it.com/v1/li/sales/lists/people?list_id=6743848588473139200&viewer_id=ACwAAAd2ql0BjIz3QGaG7pMbLYAJTx3fnRcE8-U&page=1"
541+
542+
payload={}
543+
headers = {
544+
'Authorization': lix_api_key
545+
}
546+
547+
response = requests.request("GET", url, headers=headers, data=payload)
548+
549+
print(response.json())
550+
```
551+
552+
> The above command returns JSON structured like this:
553+
554+
```json
555+
{
556+
"searchResponse": {
557+
"people": [ Person ],
558+
"paging": { "count": 25, "start": 0, "total": 250 },
559+
},
560+
"meta": {
561+
"sequenceId": "jAkFkdjfi19kFdf"
562+
}
563+
}
564+
```
565+
566+
## Sales Navigator Account List
567+
568+
This endpoint retrieves a single page of a saved Sales Navigator account list.
569+
570+
The `viewer_id` parameter is required and must be the LinkedIn ID of the account that owns the list.
571+
572+
To paginate through the list, use the `page` parameter. Each page contains 25 results.
573+
574+
<aside class="notice"> Uses 1 Standard Credit.</aside>
575+
576+
### HTTP Request
577+
`GET https://api.lix-it.com/v1/li/sales/lists/orgs`
578+
579+
### URL Parameters
580+
581+
#### Required Parameters
582+
583+
Parameter | Description
584+
--------- | -----------
585+
list_id | The ID of the account list, e.g. `6743848588473139200` for `https://www.linkedin.com/sales/lists/company/6743848588473139200`
586+
viewer_id | The LinkedIn ID of the account that owns the list
587+
588+
#### Optional Parameters
589+
Parameter | Description
590+
--------- | -----------
591+
page | The page of the list to retrieve, starting at 1
592+
sequence_id | A randomly generated string by you that is used to maintain collection settings between requests. [See the section on Sequence IDs for more information](#sequence-ids-amp-pagination)
593+
594+
```shell
595+
curl "https://api.lix-it.com/v1/li/sales/lists/orgs?list_id=6743848588473139200&viewer_id=ACwAAAd2ql0BjIz3QGaG7pMbLYAJTx3fnRcE8-U&page=1" \
596+
-H "Authorization: lixApiKey"
597+
```
598+
599+
```python
600+
import requests
601+
602+
url = "https://api.lix-it.com/v1/li/sales/lists/orgs?list_id=6743848588473139200&viewer_id=ACwAAAd2ql0BjIz3QGaG7pMbLYAJTx3fnRcE8-U&page=1"
603+
604+
payload={}
605+
headers = {
606+
'Authorization': lix_api_key
607+
}
608+
609+
response = requests.request("GET", url, headers=headers, data=payload)
610+
611+
print(response.json())
612+
```
613+
614+
> The above command returns JSON structured like this:
615+
616+
```json
617+
{
618+
"searchResponse": {
619+
"people": [ Organisation ],
620+
"paging": { "count": 25, "start": 0, "total": 250 },
621+
},
622+
"meta": {
623+
"sequenceId": "jAkFkdjfi19kFdf"
624+
}
625+
}
626+
```
627+
504628
## Search Facet Typeahead
505629

506630
This endpoint retrieves typeaheads for a LinkedIn search facet.

0 commit comments

Comments
 (0)