Listings Sync

ℹ️

About Multiple Choice Fields

The fields listing_type and property_type can accept multiple values. If omitted, default values will be used (listing_type=rentals, property_type=residential). To mix rentals and sales in the same query, include the listing_type parameter multiple times: ?listing_type=rentals&listing_type=sales.

⚠️

Authentication Required

The Listings Sync endpoint is only available using Basic Authentication. Before you use the listings sync endpoint, please confirm with your Funnel representative that your Funnel plan includes sync access, and it is enabled for your API key.

This endpoint allows you to sync listings in bulk from Funnel's database into your own. The data will be returned in paginated form with 50 listings per page, and can be filtered using query string parameters. The sync API uses pointer-based pagination. Each page of API results provides a pointer to the next available page. To get the pointer to the next page, look for the 'pointer.next_id' field in the response, and then pass that value as the max_id parameter to retrieve the next page.

GET

/api/v2/sync/listings

Request

Example request payloadGET

$ curl -X GET \
    -H "Authorization: Bearer YOUR_API_KEY" \
    "https://api.funnelleasing.com/api/v2/sync/listings"

Response

Example responseJSON200 · application/json

{
  "items": [ /* listings... */ ],
  "pointer": {
      "next_id": 234567
  }
}

Pagination Example

To retrieve the next page, use the next_id from the response as the max_id parameter:

Next page requestJSON200 · application/json

https://nestiolistings.com/api/v2/sync/listings/?max_id=234567

If you are using filter parameters, be sure to pass those along with the max_id:

Next page with filtersJSON200 · application/json

https://nestiolistings.com/api/v2/sync/listings/?updated_since=2015-05-19T12:47:00&max_id=234567

Glossary of Listings Sync Object Fields

building_ownership

The ownership class of the building. Possible values:

• 10 - Multi-family
• 20 - Condo
• 30 - Co-op
• 40 - Condop
• 60 - Single-family

building_type

The type of building structure. Possible values:

• 10 - High-Rise
• 20 - Walk-Up
• 30 - Elevator
• 40 - Hotel
• 50 - Loft
• 60 - Townhouse
• 70 - Detached House
• 80 - Attached House
• 90 - Semi-detached House
• 100 - Mid-Rise
• 110 - Low-Rise

pets

Description of what kinds of pets the building's management company allows. Possible values:

• 10 - No Pets Allowed
• 20 - Pets Allowed
• 30 - Cats Only
• 40 - Dogs Only
• 50 - Cats/Small Dogs Allowed
• 60 - Pets Allowed Case by Case

status

Describes the current status of the unit with respect to availability, pending applications, etc. Possible values:

• 100 - Available
• 200 - App Pending
• 210 - Offer Pending
• 220 - Complete App
• 230 - Approved
• 240 - Lease Out
• 250 - Transfer
• 260 - In Contract
• 300 - Under Renovation
• 310 - Hold
• 320 - Lease Break
• 400 - Rented
• 410 - Sold