API reference

Approved campaigns

Lists approved campaigns owned by this organization, optionally narrowed by campaignId. Private campaigns require an explicit matching campaign credential.

GEThttps://api.sparkglim.net/api/white-label/v1/campaigns

Access model

Access model: Verified domain and scoped public key
Required scope: campaigns:read
Documented availability: Implemented in source

Availability is verified from source, not a live production guarantee.

Private signing stays on your server. API Version 1 uses signature format v2; it is not API v2.

Headers

Name	Type	Validation
`x-white-label-domain`Required Verified website hostname used to resolve the approved organization account and bind this request.	`string`	Validation: verified HTTPS hostname.
`x-white-label-key`Required Complete issued Public or Campaign Key for the endpoint’s permitted safe-read scope.	`string`	Validation: issued Public or Campaign keyId:secret.

Parameters

Name	Type	Validation
`campaignId`Optional Existing campaign record within the caller’s account and any narrower campaign credential.	`string`	Validation: UUID within key scope.

Request

Examples describe the contract and are not executed. Use authorized test records; never paste a real secret into these pages.

GET /api/white-label/v1/campaigns

http

GET /api/white-label/v1/campaigns HTTP/1.1
Host: api.sparkglim.net
x-white-label-domain: events.example.com
x-white-label-key: <ISSUED_PUBLIC_OR_CAMPAIGN_KEY>

Response

Success response · HTTP 200

json

{
  "success": true,
  "data": [],
  "requestId": "wlapi_example"
}

Error response · HTTP 400

json

{
  "success": false,
  "error": "<ERROR_MESSAGE>",
  "requestId": "wlapi_example"
}

Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

Limits & retries

Organization limiter: 120 requests per key and 300 per IP per window; honor Retry-After and X-RateLimit headers.

Source compatibility

Authorized operations require account-specific testing.

server/src/api/router.ts
server/src/api/routes/white-label.ts
server/src/white-label/auth.ts
server/src/white-label/schemas.ts
server/src/white-label/organization-service.ts
server/src/white-label/service.ts