Skip to main content
The Hoppier API is in closed beta. Everything on this site runs in production today. Anything that doesn’t run yet is on the Coming soon page, not here.

​
Base URL

Requests and responses are JSON over HTTPS. Send Content-Type: application/json with every request that has a body.

​
Authentication

Send your API key as a bearer token:
Keys are issued by Hoppier during the beta. See Authentication.

​
Endpoints

Webhook: card.claimed.

​
Ids and units

Ids are strings with a prefix: prg_ for programs, pcpt_ for participants, ad_ for addresses. Pass them back unchanged. Amounts don’t all use the same unit. Each one is marked on its page: Program dates are Unix timestamps in milliseconds, sent as strings. More in Concepts.

​
Safe retries

POST /participants accepts an Idempotency-Key header: a UUID you generate per add and reuse on retries, so a retried request never adds anyone twice. See Errors and rate limits.

​
Versioning

The API has no version header. We add fields and error codes without notice, so ignore anything you don’t recognise. We don’t rename or remove a documented field, or change its meaning, without announcing it on the changelog first.

​
OpenAPI

This reference is generated from an OpenAPI 3.1 file. To generate a client or import the API into Postman, download the file from the page menu at the top of any page (Download API spec).