Authorization Errors
When requesting an access_token is unsuccessful, you’ll receive a response containing an error and error_description parameter.
{
"error": "invalid_request",
"error_description": "The grant type was not specified in the request"
}Codes:
- invalid_client: The api username and/or api secret key is incorrect.
- invalid_request: The request is missing a required parameter. Verify that you are passing the grant_type and scope parameters.
- unsupported_grant_type: The grant type you’ve supplied is unsupported. Make sure you are passing in client_credentials as the grant type.
- invalid_scope: The scope supplied is unsupported. Make sure you’ve supplied basic user as the scope.
Expired/Invalid Access Tokens
When an access_token expires or is invalid, you’ll receive the following response:
{
"success": false,
"msg": "Authentication failed"
}API Errors
When an API request is unsuccessful, you’ll receive an error message containing a success parameter set to false. When this happens it will be accompanied by either a msg parameter or error_code and error_msg parameters together.
{
"success": false,
"error_code": 4,
"error_msg": "You have reached your monthly free API usage limit. Please add a payment method in your account dashboard to continue using the API.",
"execution_time": 0.13372898101807
}{
"success": false,
"msg": "Missing required parameter 'email'"
}