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

POST
https://{host}/v2/LeadManagement.svc/Leads/Retrieve/ByIds?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

{
  "SearchParameters": {
    "LeadIds": [
      "0acb9356-bcd1-4128-b63a-97f52cb8cc3c",
      "3aee22bd-8419-422a-8242-c510df9af021",
      "6ba78830-bd39-435f-8687-460b677f3fb4"
    ]
  },
  "Columns": {
    "Include_CSV": "CreatedOn, ModifiedOn, CompanyType, EmailAddress, ProspectId, OwnerIdEmailAddress, ProspectAutoID, FirstName, LastName, ProspectStage"
  },
  "Paging": {
    "PageIndex": 1,
    "PageSize": 1000
  }
}

JSON Properties

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.

PageSize

Specifies the page number.

PageSize

Specifies the number of results per page.

Response

200 OK

Content-Type: application/json

{
  "RecordCount": 3,
  "Leads": [
    {
      "CreatedOn": "2018-03-06 06:55:46.000",
      "ModifiedOn": "2018-09-18 11:27:52.000",
      "CompanyType": "5003",
      "EmailAddress": null,
      "FirstName": "Ringo",
      "LastName": "Starr",
      "ProspectStage": "Opportunity"
    },
    {
      "CreatedOn": "2017-12-06 06:39:17.000",
      "ModifiedOn": "2018-07-27 09:20:50.000",
      "CompanyType": null,
      "EmailAddress": "john@example.com",
      "FirstName": "John",
      "LastName": "Lennon",
      "ProspectStage": "Prospect"
    },
    {
      "CreatedOn": "2017-12-06 06:27:04.000",
      "ModifiedOn": "2018-04-17 10:46:26.000",
      "CompanyType": null,
      "EmailAddress": null,
      "FirstName": "Paul",
      "LastName": "McCartney",
      "ProspectStage": "Prospect"
    }
  ]
}

HTTP Response Code

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.