Errors

HTTP status codes returned by the Greenspark API, including the monthly allowance.

The Greenspark API uses standard HTTP status codes to represent the result of your requests.

Successful responses

CodeTypeDescription
200OKThe request succeeded.
201CreatedThe request succeeded, and a new resource was created. This is typically the response after POST requests, or some PUT requests.

Client error responses

CodeTypeDescription
400Bad RequestThe server cannot process the request because of a client error, such as malformed syntax or a wrong parameter type.
401UnauthorizedThe API key is missing or not accepted for this route. A Public API key is accepted only on widget endpoints and the public account and community routes. Routes that require a Private API key, and the project catalog list routes, reject it.
403ForbiddenThe account plan does not include this route. A Private API key can call the API on a paid business plan. Estimations and reporting routes other than GET /v2/reports need Premium or Enterprise. Adding, verifying or deleting an email domain, and creating or updating custom email templates, need Growth, Premium, or Enterprise.
404Not FoundThe endpoint is valid, and the resource does not exist.
422Unprocessable EntityThe monthly API allowance is used up. The body message is MAX_API_CALLS_REACHED and includes resetsAt, the time the allowance resets. The allowance resets on the billing-cycle renewal, monthly even on an annual plan.

Server error responses

CodeTypeDescription
500Internal Server ErrorThe server has encountered a situation it does not know how to handle.