Getting Started

Follow Up Boss APIs support the OAuth 2.0 protocol. Integration Partners can create an OAuth Client Application to securely obtain authorization consent and perform delegated actions on behalf of a FUB user.

Prerequisites

You will need a few items before creating an OAuth Client App.

1. Registered System: FUB recommends that API clients register their system for source attribution. Therefore, OAuth Client Apps are associated with Registered Systems to extend this source attribution functionality. If you don't already have a Registered System, you can create one here.
2. Redirect URI(s): FUB uses the OAuth 2.0 Authorization Code Grant Flow to issue access tokens. After obtaining user consent, we create an authorization code and forward it to one of a given set of redirect URIs. These redirect URIs MUST BE publicly accessible and accept HTTP GET requests.

Creating an OAuth Client App

After you meet the prerequisites, you are ready to create an OAuth Client App. To do so, email [email protected] with the subject line "Request for creating an OAuth Client App". Be sure to include the following within the email:

❗️

Localhost Redirects Not Allowed

Because OAuth requires our systems to be able to access your redirect URI(s) as noted above, you will not be able to use localhost-based addresses for a redirect URI. If this is required for your development purposes, we recommend searching for a public-facing service that will allow for a redirect to your local machine.

• The redirect URI(s) for your OAuth Client App.
• The X-System value for your registered system.
• The X-System-Key IF sending the request from an email other than the "Tech Email" used to create the Registered System.

Once approved, we will provision your OAuth Client App and provide you with the Client ID and Secret associated with your OAuth Client App.