Sharing Personalized API Documentation

Modified on Thu, 4 Dec at 11:33 AM

Sharing Personalized API Documentation

Hubhus provides personalized API documentation that is automatically tailored to your account. It includes your campaigns, fields, select options, and example payloads, making it easy to give external partners accurate integration details.

On this page

Jump to any section using the links below

Hubhus provides personalized API documentation that is automatically tailored to your account. It includes your campaigns, fields, select options, and example payloads, making it easy to give external partners accurate integration details.

This article explains how to access, share, and restrict access to your API documentation.


1. Accessing your API documentation

You can open your personalized API documentation directly from your Hubhus account:

  1. Go to Account → API Documentation

  2. Click “Go to the new API documentation here”

The documentation will open in a new window.

You can also access it via a direct link:

https://leadvalidator.dk/a/YOUR_ACCOUNT_NAME/api-documentation

Replace YOUR_ACCOUNT_NAME with your Hubhus account name.


2. Sharing the documentation with external partners

You can share the documentation link with developers, integrators, or other partners.

To copy the shareable link:

  1. Open the API documentation page

  2. Click the small link icon in the top of the page

  3. Select Link

  4. Copy the URL

This URL can be safely shared with external users. It only provides access to API documentation, not to your account data.


3. Restricting which data external partners can access

Sharing the documentation does not automatically grant access to all data.
You decide exactly which data an external partner may fetch.

Hubhus allows you to apply campaign filters to restrict API access.

To create a restriction:

  1. Open the relevant campaign

  2. Go to Settings → Filters

  3. Create a new filter

  4. Define your rules — for example:

    • Only leads created after a specific date

    • Only a specific partner

    • Only certain statuses

    • Only specific tags

  5. Save the filter

Then:

  1. Go to your API documentation

  2. Scroll to the bottom of any endpoint

  3. Select your filter under “Apply filter”

External partners will now only receive data that matches your filter.

This provides a simple way to ensure data access is controlled, auditable, and limited to only what is needed.


4. Inside the personalized API view

Your Hubhus API documentation is dynamically generated based on:

  • Your API token

  • Your campaign list

  • Your custom fields

  • Your select fields and available options

  • Your lead structure

  • Your permissions

The documentation layout:

Left menu

A navigation panel containing sections such as Introduction, authentication, lead endpoints, booking endpoints, and examples.

Middle panel

Interactive options for selecting fields, parameters, or filters.

Right panel

Live-updating JSON examples showing how requests should be structured.

This makes it easy for partners to build valid requests without guessing field names or payload structure.


5. Example: Creating a lead via API

Here is a typical example from the documentation:

POST https://api.leadvalidator.dk/leads
{ "campaign_id": 362, "field_values": { "virksomhedsnavn": "VIRKSOMHEDSNAVN", "adresse": "ADRESSE", "by": "BY", "telefon-nr": "TELEFON-NR" }, "select_field_values": { "select_references": "google" } }

Authentication header

Every request must include:

Authorization: Bearer YOUR_API_TOKEN Accept: application/json

Without a valid token, the API will reject the request.


6. Summary

  • Hubhus provides personalized API documentation for your account.

  • It can be accessed and shared from Account → API Documentation.

  • You can restrict access to data using campaign filters.

  • The documentation automatically includes your campaigns, fields, and examples.

  • External partners can use the provided examples to integrate correctly and safely.

? Common searches

api setup • api integration • webhook setup • api authentication

? Also known as

integration • webhook • endpoint

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article