customInputs).
This is a discovery endpoint. The response is cacheable per organization — fetch once at startup and reuse across many link creations. The response deliberately excludes internal fields (organization IDs, processor config, billing, etc.).
Discovery flow
The intended flow when building a prefilled link is:GET /v1/organization— discoverorganizationBaseURLs(overlay availability + base URL) andglobalCustomInputs(organization-level checkout fields).GET /v1/forms/{formID}— discover form-levelcustomInputs, configured funds, frequencies, tickets, and sponsorshipproductGroups.POST /v1/forms/{formID}/links— create the link, passing prefill values keyed by titles you saw in steps 1 + 2.
Endpoint
Authentication
No request body or parameters — the organization is inferred from the API key.Response
The friendly name of your organization (e.g.
".NGO Charities"). Same value the API key was issued for.Website domains configured for this organization. The first entry is used as the base for
OVERLAY_* checkout link URLs. An empty array means overlay links are not currently available — configure a website URL in Settings → Organization in the dashboard to enable them.Organization-level custom inputs that appear on every form’s checkout, in addition to each form’s own
customInputs. Use the id or title of each as a key under prefill.customInputs when creating a link.Each object has:id(string) — stable identifier; preferred as acustomInputskey for forward-compatibility.title(string) — human-readable label shown to donors. Also accepted as acustomInputskey.inputType(string) — one ofSHORT_TEXT_INPUT,LONG_TEXT_INPUT,SINGLE_SELECTION_DROPDOWN,MULTI_SELECTION_DROPDOWN.required(boolean).options(string[]) — choices for dropdown-typed inputs; empty for text inputs.
Status codes
Example
cURL
What’s NOT exposed
By design, this endpoint returns only the fields needed to build prefilled links. It does not include:- Internal IDs (organization ID, Clerk org ID, processor account IDs)
- API key material
- Payment processor configuration (Stripe, Finix)
- Billing details, fee schedules, tax IDs
- Onboarding state, payout details