Search for Records

Use this API call to find records within Shape. This is often used to get the Shape lead ID in order to use that information with other API calls

POST /search/lead

To search records in Shape, send an authorized POST request to https://secure-api.setshape.com/api/search/lead

Parameters

Search for leads with at least one of the following parameters:

  • lead_id

    Find record information in Shape by using the Shape lead ID if you have this information.

  • phone

    Find lead information in Shape by using the record's unique phone number if you have this information.

  • email

    Find lead information in Shape by using the record's unique email address if you have this information.

Request Header

The authentication token must be passed in the request header for every API request. You can find and generate your authentication token in your system settings page under “API Integrations.”

Request Body

JSON request body formatting example:

{

     “email”: “johndoe@gmail.com”

}

Response

Upon success, the server returns HTTP codes and messages in the header with some additional elements and properties that are set by the server, such as id.

{

     “lead_id”: 123,

     “firstname”: “John”,

     “lastname”: “Doe”,

     “phone”: “5555555555”,

     “email”: “johndoe@gmail.com”

}

Get in Touch

Our team of experts are here to help! Call our sales line at (888) 762-7211

Download

Contact Sales