Find records by one or more criteria. A successful search returns a JSON array.
POSThttps://secure-api.setshape.com/api/search/lead/{crmid}
Replace
{crmid} with your Shape system ID — found on the API Integrations page. Every request also needs your auth header — see Using Shape APIs.Body parameters
Supply at least one supported criterion. Branch augmentation does not search child branches by loan number.
| Field | Requirement | Meaning |
|---|---|---|
lead_id |
At least one required | Shape record ID. |
phone |
At least one required | Phone number. |
email |
At least one required | Email address. |
trkloannnumber |
At least one required | Tracking loan number. |
Example request
curl -X POST https://secure-api.setshape.com/api/search/lead/{crmid}
-H "Authorization: {YOUR_API_AUTHORIZATION_KEY}"
-H "Content-Type: application/json"
-d '{ "email": "jamie@example.test" }'{
"email": "jamie@example.test"
}Status codes
| Status | Meaning |
|---|---|
| 404 Not Found | No matching record was found. |
| 422 Unprocessable | No supported search criterion was supplied. |
| 500 Server Error | The search could not be completed. |