Skip to main content

Introduction

Funnel Partner API

The Funnel Partner API is designed for building reusable integrations intended to serve multiple customers (not tied to a single customer account). If you are a third-party developer or integration partner building solutions that will be used by multiple Funnel customers, you should use the Partner API. The Partner API provides access to similar functionality as the Customer API but with different access controls and terms suitable for multi-tenant integrations.

ℹ️

Before you build

Review License Agreement for the legal, security, and operational requirements for production use of the Funnel Partner API.

Who can use these APIs

The Funnel Partner API is intended for third-party developers and integration partners building reusable solutions. Common authorized users include:

  • Integration partners building solutions that will be used by multiple Funnel customers
  • Third-party developers creating applications or services that integrate with Funnel across multiple customer accounts
  • Technology vendors providing multi-tenant integrations for property management companies using Funnel
  • Platform providers building white-label or reseller solutions that incorporate Funnel functionality

If you are building an integration for a single Funnel customer account, refer to the Customer API documentation for account-specific access and terms.

Typical use cases

Use the Funnel Partner API to build multi-tenant integrations and workflows such as:

  • Appointment booking systems that integrate with Funnel's scheduling across multiple properties
  • Prospect management tools that create and manage leads in Funnel for multiple customers
  • Communication platforms that send messages through Funnel's communication channels
  • Task management systems that create and track tasks within Funnel workflows
  • Resident app integrations that enhance the resident experience with third-party functionality
  • Customer scoring systems that update prospect scores based on external data
  • Renewal status tracking that syncs renewal information with external systems
  • Community and unit data retrieval for building property search and listing experiences
  • Chat and conversation management for customer service integrations

Available endpoints and functionality depend on your Partner API access level and the specific capabilities enabled for your integration.

Getting started

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

  • Request API access: Contact Funnel to obtain Partner API credentials. You'll receive an API key that you can use for authentication.
  • Review the License Agreement: Understand the legal, security, and operational requirements for using the Partner API in production.
  • Understand authentication: Learn how to authenticate using Basic Auth or Bearer Token (see Authentication section below).
  • Explore available endpoints: Review the endpoint reference sections in the left navigation to understand available functionality.

After completing the steps above, you can begin integrating with the Partner API endpoints that match your use case.

Authentication

Funnel provides you with an API key for authentication. You can use it in either of the following ways:

Option 1: Basic Auth

Use the API key as the username with an empty password.

Option 2: Bearer Token

Use the API key directly as a bearer token. Example header:

Authorization: Bearer <API_KEY>
⚠️
Keep your API key secure and never share it publicly. Treat it as a sensitive credential and use secure storage practices.

OpenAPI Specification

The Partner API follows the OpenAPI 3.0.0 specification, providing a standardized interface for integration. The API supports two authentication schemes:

BasicAuth

Use API key as username and leave password blank.

Security scheme type: http

Scheme: basic

BearerAuth

Use your API key as bearer token in the Authorization header. Example: Authorization: Bearer <API_KEY>

Security scheme type: http

Scheme: bearer

Bearer format: API Key

Operational guidance

Partner API integrations are typically multi-tenant services serving multiple customers. To keep production usage reliable:

  • Implement proper error handling: Handle API errors gracefully and implement retry logic with exponential backoff for transient failures.
  • Respect rate limits: Avoid making excessive requests that could impact API performance. Implement request throttling and caching where appropriate.
  • Use community identifiers correctly: The Partner API supports Funnel Community IDs, Syndication IDs, and Partner IDs. Use the appropriate identifier format for each customer.
  • Protect API credentials: Use secure credential storage and never expose API keys in client-side code or public repositories.
  • Monitor integration health: Track API usage, error rates, and response times to ensure your integration remains healthy.
  • Plan for multi-tenancy: Design your integration to handle data isolation and security across multiple customer accounts.
ℹ️

Rate limit guidance

Funnel does not publish a fixed request-per-second limit for the Partner API. Usage patterns that create excessive load may be throttled or blocked. If you expect high request volume, contact support to discuss your use case and ensure appropriate rate limits are configured.

Support

For help with Partner API access or integration issues:

  • Contact your Funnel partner representative for API access, onboarding, or partnership questions.
  • Email apisupport@funnelleasing.com for Partner API integration support and technical questions.
  • Review the endpoint documentation in the left navigation for specific endpoint details, request/response formats, and error codes.