Skip to content

API - Landlords Search (Advanced API Only)

← Developers
Introduction to Landlords Search API

Landlords Search API provides developers with a programmatic way to search for your landlords in your YGL account.

Landlords Request Syntax

To retrieve data using the Landlords Search API, you need to send a SECURE HTTP POST request to the follow URL: https://www.yougotlistings.com/api/landlords/search.php

You can use the following list of POST parameters to filter the landlords returned from the API Server. Large result sets are generally slower to retrieve than smaller result sets. The maximum number of results returned in any request is 500. All parameters are case sensitive.
Name Required? Default Value Possible Values Purpose
landlord_id Optional Null Integer If specified, the landlord with matching id is returned.
landlord_ids Optional Null ID numbers separated by comma. If specified, the landlords with matching ids are returned.
key Required N/A Exactly as provided by YGL Authentication. Unauthorized requests are rejected.
Landlords Response Syntax

Response from the Landlords Search API will be in JSON format. 

Response to a Successful Request
{
    "subTotal": 10,
    "total": 133,
    "pageIndex": 1,
    "pageCount": 100,
    "sortName": "id",
    "sortDir": "asc",
    "landlords": [
        {
            "id": 6218040,
            "name": "Anna Smith",
            "phone1": "(773) 323-4822",
            "phone2": null,
            "email": null,
            "internal_notes": null,
            "broker_notes": null,
            "tags": [
                "ABC"
            ]
        }
        ...
    ]
}

Feedback and Knowledge Base

(thinking…)