Error Reference

All errors follow a consistent JSON format. Check the HTTP status code and the error field in the response body.

Error format

{
  "error": "unauthorized",
  "message": "Invalid or missing API key",
  "status": 401
}

Code	Name	Description	How to fix
`400`	Bad Request	Invalid query parameters or request body.	Check parameter types and required fields.
`401`	Unauthorized	Missing or invalid API key.	Include a valid X-API-Key header.
`403`	Forbidden	API key lacks the required scope.	Upgrade your plan or create a new token with the required scope.
`404`	Not Found	Resource does not exist.	Check the resource ID in the URL.
`429`	Too Many Requests	Rate limit exceeded.	Wait for the Retry-After period or upgrade your plan.
`500`	Internal Server Error	Something went wrong on our end.	Retry the request. If persistent, contact data@apply.org.za.
`503`	Service Unavailable	API is temporarily unavailable.	Check status.apply.org.za and retry with exponential backoff.