API setup and authentication

Modified on Tue, 5 May at 9:30 PM

API setup and authentication

Hubhus provides a REST API for reading and writing lead data. You can create scoped tokens per vendor (best practice) or broad tokens for internal integrations.

TL;DR

Scoped token (external vendor): Campaign → API documentation → API Tokens → select campaign filter → create token. Share public API URL + token string. General token: Account → API documentation → API Tokens. All tokens use Bearer authentication. Tokens are credentials — keep them secret.

Get started in 6 steps — scoped vendor token

Add a source value for the vendor

In the campaign, go to Selects. Find the source/vendor select list and add a new option for the vendor (e.g. "Vendor XYZ"). This value identifies their leads in the filter.

Create a campaign filter for the vendor

In the campaign, go to Filters → New filter. Name it after the vendor. Add condition: source field equals the vendor's select value. This filter defines exactly which leads the API token will expose.

Open API Tokens in the campaign

In the campaign, go to API documentation → API 2023. Scroll to the bottom and click "Go to new API documentation". In the new UI, navigate to API Tokens.

Create a scoped API token

Click New API Token. Name it clearly (e.g. "Vendor XYZ – read only"). Set permissions (read / read+write). Under Campaign filter, select the filter from step 2. Save.

Get the public API URL and token value

In the token list, click the link icon to get the public API documentation URL. Click Show to reveal the token string. Both are needed by the vendor.

Share with vendor

Send the vendor the public API URL and the token string. The public API documentation automatically shows their campaign's exact schema — all fields, selects, statuses, and required parameters — so they can build correct requests without guesswork.