Get Leads in Bulk by Ids
Lets you retrieve multiple leads by passing their lead ids.
- The “LeadIds” parameter is mandatory. You can pass multiple lead Ids here.
- The “Include_CSV” parameter is also mandatory. Pass the columns you want to retrieve here.
Note: You can retrieve a maximum of 10,000 leads.
API URL
Request
Content-Type: application/jsonRequest Parameters
Parameter | Description |
---|---|
LeadIds | Pass the lead Ids (also known as the Prospect Id) of the leads you want to retrieve here. |
Include_CSV | Pass the names of the columns you want to retrieve for the leads here. |
PageIndex | Specifies the page number. |
PageSize | Specifies the number of results per page. |
Response
HTTP Response Codes
Code | Description |
---|---|
200 OK | This is the status code for successful API call. |
401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
404 Not Found | The API could not be found. Please check the API signature. |
429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |