Errors and Status Codes
Most v2 routes follow the same HTTP conventions:
| Status | When | Response body |
|---|---|---|
| 200 OK | Successful GET or PUT | Resource or list object with mode |
| 201 Created | Successful POST that creates a resource (for example, POST /invitations) | Created object with mode |
| 400 Bad Request | Invalid request body, validation failure, unknown resource ID, or business rule violation | { "error": "message" } or, for some schema errors, { "error": [ … ] } |
| 404 Not Found | Missing or invalid API key, or account not found for the key | { "error": "API key is required" } or { "error": "Account not found for API key" } |
| 405 Method Not Allowed | HTTP method not supported for the route | Plain text message |
Notes
- Wrong or missing resource IDs (for example, an invitation or test taker that does not belong to your account) usually return 400, not 404.
- Validation errors for invitation create requests may reference internal field names such as
sent_to_emaileven though the request body usesemail. GET /career-navigation-profiles/:careerNavigationProfileIdreturns 404 with anullbody when the profile is not found. This differs from most other GET-by-ID routes.
See API Keys for test-key behavior. Endpoint-specific validation errors are documented on individual route pages (for example, Invitations).