Docs/Developer & API/API overview
🛠️

API overview

Developer & API

Base URL

All GB Tick API requests are made to: https://api.gbtick.app/v1/

Authentication

All endpoints require a Bearer token. Generate API keys from Settings → Developer → API Keys. Scope tokens to specific permissions (read, write, admin).

Rate limits

Default rate limit is 300 requests per minute per API key. Broadcast and bulk endpoints have separate per-campaign limits. Headers X-RateLimit-Remaining and X-RateLimit-Reset are returned on every response.

Response format

All responses are JSON. Successful responses return HTTP 200 or 201. Errors return 4xx or 5xx with an error object containing a code, message, and optional details array.

Webhooks

Register webhook endpoints in Settings → Developer → Webhooks. GB Tick signs all payloads with HMAC-SHA256. Verify the X-GB Tick-Signature header to authenticate incoming events.