API Documentation - Agents

Table of Contents

Company Agents

GET /api/v2/agents/

Returns a list of all active agents for the company assigned to the API key.

Example request made via client side JavaScript using jQuery:

var apiData = $.ajax("https://nestiolistings.com/api/v2/agents/?key=<your_key>")

Example response body:

{
total_items: 3,
items: [
    {
        phone_number: "212-555-5555",
        bio: "",
        mobile_phone_number: "917-555-5555",
        name: "Andy Apple",
        title: "",
        email: "andy@brokeragewebsite.com",
        headshot: {
            original: "https://nestiolistings-assets-dev.s3.amazonaws.com/user_photos/originals/08a41c63c8d9b4491acfe43963dffd42.jpg",
            thumbnail: "https://nestiolistings-assets-dev.s3.amazonaws.com/user_photos/thumbnail/08a41c63c8d9b4491acfe43963dffd42.jpg"
        },
        id: 2608
    },
    {
        phone_number: "555-555-5555",
        bio: "I am a broker and I like to rent apartments all day every day. ",
        mobile_phone_number: "555-565-5656",
        name: "Mike Broker",
        title: "Licensed Real Estate Salesperson",
        email: "mikeb@brokeragewebsite.com",
        headshot: {
            original: "https://nestiolistings-assets-dev.s3.amazonaws.com/user_photos/originals/0b62f4507c8b0dcba8526ed5b8763423.jpg",
            thumbnail: "https://nestiolistings-assets-dev.s3.amazonaws.com/user_photos/thumbnail/0b62f4507c8b0dcba8526ed5b8763423.jpg"
        },
        id: 19
    },
    {
        phone_number: "908-675-3716",
        bio: "",
        mobile_phone_number: "",
        name: "Caren M",
        title: "Licensed Real Estate Salesperson",
        email: "carenm@brokeragewebsite.com",
        headshot: {
            original: "https://nestiolistings-assets-dev.s3.amazonaws.com/user_photos/originals/fab38cb3dca4131c85b271a1fe271724.jpg",
            thumbnail: "https://nestiolistings-assets-dev.s3.amazonaws.com/user_photos/thumbnail/fab38cb3dca4131c85b271a1fe271724.jpg"
        },
        id: 2154
    }
],
total_pages: 1,
page: 1
}

Single Agent

GET /api/v2/agents/<agent_id>/

Returns a single agent. Limited to agents for the company assigned to the API key.

Example request made via client side JavaScript using jQuery:

var apiData = $.ajax("https://nestiolistings.com/api/v2/agents/<agent_id>/?key=<your_key>")

Example response body:

{
    phone_number: "555-555-5555",
    bio: "I am a broker and I like to rent apartments all day every day. ",
    mobile_phone_number: "555-565-5656",
    name: "Mike Broker",
    title: "Licensed Real Estate Salesperson",
    email: "mikeb@brokeragewebsite.com",
    headshot: {
        original: "https://nestiolistings-assets-dev.s3.amazonaws.com/user_photos/originals/0b62f4507c8b0dcba8526ed5b8763423.jpg",
        thumbnail: "https://nestiolistings-assets-dev.s3.amazonaws.com/user_photos/thumbnail/0b62f4507c8b0dcba8526ed5b8763423.jpg"
    },
    id: 19
}