SparkGlim
SparkGlim
Developer
Explore
OverviewGetting StartedSparkGlim EmbedsPublic Embed APIWhite Label Organization APIWhite Label Reseller APIAuthenticationWebhooksCampaign IntegrationsTicketing IntegrationsVoting IntegrationsFundraising IntegrationsRequests and ResponsesError HandlingDeveloper GuidesChangelog
API product

White Label Organization API

Version 1 routes for approved white-label organizations.

Audited route registry

The endpoint list below is generated from the existing typed documentation registry and validated against implemented server sources.

Product-specific contract

Authentication, route prefix, request fields, response shape, and permissions remain separate from the other API products.

White-Label API

Implemented endpoints

Version 1 API for approved white-label organizations using SparkGlim infrastructure under their own brand.

Authentication: HMAC-signed requests with x-white-label-key-id, x-white-label-signature, x-white-label-timestamp, and x-white-label-nonce.

GET/api/white-label/v1/context

Get account context

Loads the current white-label account context for an enabled account.

White-label HMAC authenticationSuccess: 200
GET/api/white-label/v1/campaigns

List campaigns

Lists campaigns visible to the authenticated white-label account.

White-label HMAC authenticationSuccess: 200
POST/api/white-label/v1/campaigns

Create campaign

Creates a white-label campaign. Supported campaign_type values are voting, donation, and ticketing.

White-label HMAC authenticationSuccess: 201
PATCH/api/white-label/v1/campaigns/:campaignId

Update campaign

Partially updates an existing campaign owned by the white-label account.

White-label HMAC authenticationSuccess: 200
GET/api/white-label/v1/ticket-types

List ticket types

Lists ticket types, optionally filtered by campaignId.

White-label HMAC authenticationSuccess: 200
POST/api/white-label/v1/ticket-types

Create ticket type

Creates a ticket type for a ticketing campaign.

White-label HMAC authenticationSuccess: 201
GET/api/white-label/v1/participants

List participants

Lists voting participants/nominees for white-label campaigns.

White-label HMAC authenticationSuccess: 200
POST/api/white-label/v1/payments/initialize

Initialize payment

Initializes a vote, donation, or ticket payment through the white-label account provider routing.

White-label HMAC authenticationSuccess: 200
POST/api/white-label/v1/withdrawals

Create withdrawal request

Creates a withdrawal request. This route requires a secret key, withdrawal-enabled API key, and idempotency key.

White-label HMAC authentication with secret key onlySuccess: 201
GET/api/white-label/v1/settings

Read settings

Returns white-label settings, optionally filtered by categories.

White-label HMAC authenticationSuccess: 200

Continue exploring Developer

Developer OverviewGetting StartedSparkGlim EmbedsPublic Embed APIWhite Label Reseller APIAuthentication
Return to SparkGlim