Skip to main content

Errors and Status Codes

Most v2 routes follow the same HTTP conventions:

StatusWhenResponse body
200 OKSuccessful GET or PUTResource or list object with mode
201 CreatedSuccessful POST that creates a resource (for example, POST /invitations)Created object with mode
400 Bad RequestInvalid request body, validation failure, unknown resource ID, or business rule violation{ "error": "message" } or, for some schema errors, { "error": [ … ] }
404 Not FoundMissing 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 AllowedHTTP method not supported for the routePlain 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_email even though the request body uses email.
  • GET /career-navigation-profiles/:careerNavigationProfileId returns 404 with a null body 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).