Developer Portal

Manage API keys, webhooks and view API usage

API Reference

Save this now — it will not be shown again. Store it securely (e.g. a password manager or secrets vault).

Your API Key

No API key exists yet. Generate one to start using the Surveyz API.

—
—
—
—
Loading...

Quick-start

Pass your API key in the X-Api-Key header on every request.

curl https://surveyz.co.za/api/surveys \
  -H "X-Api-Key: YOUR_KEY_HERE"

Base URL: https://surveyz.co.za/api  |  Version alias: https://surveyz.co.za/api/v1

Rate limits

300
requests / minute (authenticated)
60
requests / minute (anonymous)

When exceeded, the API returns HTTP 429 with a Retry-After: 60 header.

Key Settings

Read-only keys cannot create, update, or delete resources.

Comma-separated IPv4 addresses. Leave blank to allow all IPs.

Public B2B Endpoint Reference

All endpoints require X-Api-Key or a JWT Bearer token unless noted.

MethodPathDescriptionScope
GET/api/surveysList your surveysread_only
GET/api/surveys/{id}Get a single surveyread_only
POST/api/surveysCreate a surveyfull
PUT/api/surveys/{id}Update a surveyfull
DELETE/api/surveys/{id}Delete a surveyfull
GET/api/surveys/{id}/responsesList responsesread_only
GET/api/surveys/{id}/exportExport responses (CSV/JSON)read_only
GET/api/developer/api-keyView key metadataread_only
GET/api/developer/audit-logsView API audit logread_only
GET/api/webhooksList webhooksread_only
POST/api/webhooksCreate webhookfull
DELETE/api/webhooks/{id}Delete webhookfull
Time Method Path Status Duration Auth IP
Loading...

Webhook Subscriptions

We sign payloads with HMAC-SHA256. Verify the X-Surveyz-Signature header.

Loading...

No webhooks yet. Add one to receive real-time event notifications.

Available events

survey.published Fired when a survey is published or made live
survey.closed Fired when a survey is closed or expires
response.submitted Fired each time a respondent submits a response