API Search Leads - Shape Software - Automate your business!

Instructions

Shape Software API

  • Introduction
  • Using Shape APIs
  • Status Codes
  • Rate Limits

POST API Calls

GET API Calls

Search for Leads

GET /search/lead

To search leads in Shape, send an authorized GET request to https://secure.setshape.com/api/search/lead

Parameters

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

Parameter — Lead ID is the record identifier.

Parameter — the phone number on record.

Parameter — the email address on record.

Request Header

The authentication token should be passed in the request header for every API request.

Content-Type: application/json
Authorization=xxxxxxxxxxxxxxxxxxxxxxxx

Request Body

JSON request body formatting example:

{
  "lead_id": "60313",
}

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.

{
  "firstname": "John",
  "lastname": "Doe",
  "email": "johndoe@yahoo.com",
  "phone": "2342342342"
}

How to Get Field Names

Field names can be found within your CRM System’s settings pages under: Settings > Marketing Sources > Edit Any Marketing Source > Campaign Source Post URL Instructions.

 

After navigating to the marketing sources settings page and opening up a campaign, scroll to the bottom of the page to the “Campaign Source Post URL Instructions” section. Here, you will find a searchable table with a breakdown of all of the field names available for use. These field names can also be exported to a CSV via the “Export” dropdown.