Skip to main content

Introduction

Funnel Customer APIs

Funnel Customer APIs are provided to Funnel customers (for example, property management companies) to integrate Funnel into internal systems and production workflows. Access is restricted to customer-authorized users, including internal engineering teams and approved development partners, using credentials issued for the customer’s account.

ℹ️

Before you build

Review Usage & Terms for the legal, security, and operational requirements for production use of the Funnel Customer APIs.

Who can use these APIs

Funnel Customer APIs are intended for authorized individuals acting on behalf of a Funnel customer. Common authorized users include:

  • Customer employees building and operating integrations for the customer’s systems
  • Customer-authorized contractors or development partners implementing an integration for a specific customer account
  • Customer IT and security teams managing credentials, environments, and operational access

If you are building a reusable integration intended to serve multiple customers (not tied to a single customer account), refer to the Partner API documentation for separate access and terms.

Typical use cases

Use the Funnel Customer APIs to support customer-owned integrations and workflows such as:

  • Retrieving listings and related data for internal tools and customer-facing experiences
  • Integrating Funnel data with property management systems, CRMs, and operational workflows
  • Building dashboards and reporting pipelines based on Funnel data
  • Running scheduled synchronization jobs using supported sync endpoints where available
  • Automating operational processes that depend on Funnel data and events

Available resources and fields depend on your customer account configuration and the permissions associated with your credentials.

Getting started

For most customer integrations, the fastest path to a safe production launch is:

  • Authentication: how to obtain and use credentials issued for your customer account
  • Usage & Terms: requirements for acceptable use, security, rate-limit expectations, and production operation
  • Errors: how to interpret error responses and implement reliable retries and fallbacks

After completing the pages above, you can proceed to the endpoint reference sections in the left navigation.

Operational guidance

Customer API integrations are typically long-lived services. To keep production usage reliable:

  • Use backoff on retries for transient failures and follow the guidance on the Errors page.
  • Avoid tight polling loops. Scheduled jobs are expected, but high-frequency automated requests that create unnecessary load are not permitted.
  • Use sync endpoints for bulk workflows when you need to transfer or reconcile large amounts of data.
  • Protect credentials using your organization’s standard secret-management practices.
  • Plan for scaling. If you expect high request volume or frequent synchronization, contact support so we can recommend the right approach.
ℹ️

Rate limit guidance

Funnel does not publish a fixed request-per-second limit for Customer APIs. Usage patterns that create excessive load may be throttled or blocked. For bulk synchronization, use the Listings Sync Endpoint where available or contact support to discuss options for your use case.

Support

For help with Customer API access or integration issues:

  • Contact your Funnel customer service representative for account access, permissions, or onboarding questions.
  • Email support@funnelleasing.com for API integration support.
  • Use the Errors page when troubleshooting response codes, retries, and request failures.