Overview
SpringAPI uses standard HTTP status codes to indicate the success or failure of a request.
All responses are returned in JSON format.
Success Responses
HTTP Code | Meaning | Description |
200 OK | Success | The request was successful and data is returned in the response body |
Client Error Responses
HTTP Code | Meaning | Description |
400 Bad Request | Invalid Request | The request was malformed or contains invalid parameters |
401 Unauthorized | Authentication Failed | Missing, invalid, or revoked X-Spring-API-Key |
404 Not Found | Resource Not Found | The requested resource does not exist or is not accessible |
Error Response Format
When applicable, error responses may include a JSON payload describing the issue:
{
"error": "Invalid awardCycleId."
}Some authentication failures may return an empty response body with a 401 Unauthorized status.
Authentication Failures (401)
A 401 Unauthorized response occurs when:
The X-Spring-API-Key header is missing
The token value is invalid
The token has been revoked
Notes
Endpoint-specific error responses are documented within each endpoint article
Only errors relevant to the request will be returned
Future endpoints may introduce additional status codes as functionality expands