API - Leads Search
Leads Search API provides developers with a programmatic way to search for your leads information in your YGL account.
Leads Search Request Syntax
To retrieve data using the YGL Leads API, you need to send a SECURE HTTP POST request to the follow URL: https://www.yougotlistings.com/api/leads/search.php
You can use the following list of POST parameters to retrieve account info returned from the API Server. All parameters are case sensitive.
| Name | Required? | Default Value | Possible Values | Purpose |
|---|---|---|---|---|
| key | Required | N/A | Exactly as provided by YGL | Authentication. Unauthorized requests are rejected. |
| lead_id | Optional | Null | Integer | |
| page_index | Optional | Null | Integer | Paging index, if specified only leads starting on that page are returned. Must be used in conjunction with page_count. |
| page_count | Optional | Null | Integer | Specifies the number of leads returned per page. Can be used for paging when defined in conjunction with page_index. If used alone, it limits the total number of results returned. |
Response from the YGL Account API will be in JSON format.
JSON Response to a Successful Request
[
{
"id":12345,
"agent_id":1,
"status":"Nurture",
"first_name":"John",
"last_name":"Doe",
"source":"Zillow.com",
"phone":"334-555-6632",
"emails":["marcus@yglmail.com"],
"recommended_rental_ids":[12345, 45678],
"public_url":"http://ygl.is/g/w/12345"
}
]