Responses

The API returns HTTP responses on each request to indicate the success or otherwise of API requests. The codes listed below are often used, and the API may use others.

Response codes

Successful API responses will have a 2xx HTTP status code.

Success code

Description

200

Ok - The request has succeeded.

201

Created - The request has succeeded and a new resource has been created as a result of it

204

No Content - There is no content to send for this request, but the headers may be useful

Note that 4xx and 5xx responses may be returned for any request and clients should cater for them.

Error code

Description

400

Bad Request - Your request included invalid JSON

401

Unauthorized - You have not been authenticated

403

Forbidden - You have been authenticated, but you don't have a permission for the requested resource

404

Not Found - The resource you requested could not be found

409

Conflict

422

Unprocessable Entity - used for validation errors

429

Too many requests

500

Server errors - something went wrong with TalentLyft's servers.

502

Server errors - something went wrong with TalentLyft's servers.

503

These responses are most likely momentary operational errors (e.g. temporary unavailability), and, as a result, requests should be retried once.

504

These responses are most likely momentary operational errors (e.g. temporary unavailability), and, as a result, requests should be retried once.

Validation

Methods that take input will validate all parameters. Any parameter that fails validation will trigger an error response with status HTTP 422. The response body will be a JSON object that includes a message as well as a list of fields that failed validation.

{
"Message": "Validation Failed",
"Errors": [
{
"Message": "This is a model-wide error"
},
{
"Field": "Url",
"Message": "'Url' should not be empty."
}
]
}