Skip to content

Commit d17cd08

Browse files
docs: add warmup response to Get LinkedIn Account endpoint
Co-Authored-By: Adil <adil@lix-it.com>
1 parent fb1dc03 commit d17cd08

1 file changed

Lines changed: 73 additions & 0 deletions

File tree

src/app/linkedin-account/page.mdx

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,79 @@ The above commands return JSON structured like this:
7878
```
7979

8080

81+
</Col>
82+
83+
</Row>
84+
85+
---
86+
87+
<Row>
88+
89+
<Col>
90+
91+
## Get LinkedIn Account
92+
93+
This endpoint retrieves a LinkedIn account attached to your team.
94+
95+
### HTTP Request
96+
97+
`GET https://api.lix-it.com/v1/account/linkedin/account`
98+
99+
### URL Parameters
100+
101+
Parameter | Description
102+
|--------- | -----------
103+
viewer_id | The LinkedIn ID of the account to retrieve.
104+
105+
</Col>
106+
107+
<Col sticky>
108+
109+
<CodeGroup title="Get LinkedIn Account" tag="GET" label="/v1/account/linkedin/account">
110+
111+
```bash {{ title: 'Shell' }}
112+
curl "https://api.lix-it.com/v1/account/linkedin/account?viewer_id=alfie-lambert" \
113+
-H "Authorization: lixApiKey"
114+
```
115+
116+
```python
117+
import requests
118+
import json
119+
url = "https://api.lix-it.com/v1/account/linkedin/account"
120+
headers = {
121+
'Authorization': lix_api_key
122+
}
123+
params = {
124+
'viewer_id': 'alfie-lambert'
125+
}
126+
response = requests.request("GET", url, headers=headers, params=params)
127+
print(response.json())
128+
```
129+
130+
</CodeGroup>
131+
132+
The above command returns JSON structured like this:
133+
134+
```json
135+
{
136+
"viewerId": "alfie-lambert",
137+
"linkedInReady": true,
138+
"salesNavigatorReady": false,
139+
"warmup": {
140+
"status": "warming",
141+
"details": {
142+
"active_days": 2,
143+
"daily_limit": 100,
144+
"hourly_limit": 40,
145+
"max_daily_limit": 500,
146+
"max_hourly_limit": 100
147+
}
148+
}
149+
}
150+
```
151+
152+
The `warmup` object is only present when the account warmup feature is enabled for the account. When warmup is complete the `status` field becomes `"completed"` and the `active_days` and limits reflect the final tier.
153+
81154
</Col>
82155

83156
</Row>

0 commit comments

Comments
 (0)