Sharing Personalized API Documentation

Modified on Wed, 6 May at 7:10 AM

Sharing personalized API documentation

Hubhus generates personalized API documentation automatically for your account — including your exact campaigns, fields, select options, statuses, and example payloads. You can share this directly with external partners.

TL;DR

Go to Account → API documentation → Go to new API documentation. Click the link icon in the top of the page to get a shareable URL. Share that URL + an API token with the partner. The documentation automatically shows their campaign schema. Apply a campaign filter to restrict which data they see.

3 things to know

Access and share the documentation

Go to Account → API documentation → click "Go to the new API documentation here". Click the link icon at the top and select Link to copy the shareable URL. This URL is safe to share — it only grants access to the documentation, not your account data. Direct URL pattern: https://leadvalidator.dk/a/YOUR_ACCOUNT_NAME/api-documentation

What partners see in the documentation

The documentation is dynamically generated from your account: all campaigns, custom fields, select options, allowed values, status slugs, required parameters, and live JSON example payloads. Partners can copy the schema directly to build correct POST bodies — no guessing field names or structures. Every request must include: Authorization: Bearer YOUR_API_TOKEN

Restrict what partners can access

Sharing the docs URL does not expose your data. To restrict API data access, create a campaign filter (Settings → Filters) and link it to the API token. Partners then only see leads matching that filter. The documentation auto-reflects only their campaign structure.

Read more⌄

Example API request structure

Endpoint (shown in the documentation):

POST https://api.leadvalidator.dk/leads

Required headers for every request:

Authorization: Bearer YOUR_API_TOKEN
Accept: application/json

Example request body (field names are generated from your actual campaign schema — they will match your own field slugs):

{
  "campaign_id": 362,
  "field_values": {
    "virksomhedsnavn": "VIRKSOMHEDSNAVN",
    "adresse": "ADRESSE",
    "by": "BY",
    "telefon-nr": "TELEFON-NR"
  },
  "select_field_values": {
    "select_references": "google"
  }
}

Inside the API documentation view

Left menu — navigation between sections: Introduction, Authentication, lead endpoints, booking endpoints, and examples
Middle panel — interactive field and parameter selection, filter application per endpoint
Right panel — live-updating JSON examples that reflect your selections. Copy these directly for integration testing and partner handoff

How to apply a data filter for a partner:

Go to Campaign settings → Filters and create a new filter (e.g. "Only leads from source X" or "Only leads after date Y")
Open the API documentation and scroll to the bottom of the relevant endpoint
Select your filter under "Apply filter"
Share the resulting scoped token — the partner will only receive leads that match the filter

Common searches

share api documentation • partner api docs • personalized api • api schema • api integration documentation

API setup and authentication
How do I give API access to a specific campaign?
How do I read/get leads via API?
What is the Hubhus API?