Response Codes

26min

Employee API will be deprecated on August 6th. Until then, you must transfer to a Base Employee API﻿ . Read all about the benefits and changes here﻿.
﻿Employee API response codes﻿
﻿Bulk Collect response codes﻿
﻿Webhooks response codes﻿
Employee API endpoint response codes
Explore the variety of possible response codes and what they mean in the Employee API. 
These error codes can be encountered in all Employee API endpoints, such as:
Search and collect endpoints
Bulk Collect endpoints
Webhook (subscriptions) endpoints.
A successful query will return the 200 code. 
An unsuccessful query will return any of the following error codes.
Error code
Description
400
Request was unacceptable, often due to a missing required parameter. 

The error message differs based on the error:
Several examples
{ 
 "Error": "Query validation failed: Failed to parse query [('IT Company' OR 'Labs']"
},
{ 
 "Error": "Query validation failed: failed to create query: [nested] failed to find nested object under path [member_experience_collection]"
},
{
"Error": "Query validation failed: [fuzzy] query doesn't support multiple fields, found [must] and [must]"
},
{
"Error": "Query validation failed: request does not support [query_string]"
},
{
  "Error": "Query validation failed: failed to create query: compile error" 
},
{ 
 "Error": "Failed to parse es dsl query"
},
{ 
 "Error": "Query results count exceeds allowed limit"
},
{
  "Error": "Query execution was cancelled due to timeout"
},
{
  "Error": "Query validation failed: failed to create query: compile error" 
}
{ 
 "Error": "Query validation failed: Failed to parse query [('IT Company' OR 'Labs']"
},
{ 
 "Error": "Query validation failed: failed to create query: [nested] failed to find nested object under path [member_experience_collection]"
},
{
"Error": "Query validation failed: [fuzzy] query doesn't support multiple fields, found [must] and [must]"
},
{
"Error": "Query validation failed: request does not support [query_string]"
},
{
  "Error": "Query validation failed: failed to create query: compile error" 
},
{ 
 "Error": "Failed to parse es dsl query"
},
{ 
 "Error": "Query results count exceeds allowed limit"
},
{
  "Error": "Query execution was cancelled due to timeout"
},
{
  "Error": "Query validation failed: failed to create query: compile error" 
}
﻿
﻿
Error code
Description
401
No valid API bearer token {JWT} was provided. Check if your token is valid and try again.
404
Nonexistent API URL: Using DBAPI instead of CDAPI in the API URL while making a request will result in a 404 error message.
Nonexistent ID:  Using a profile ID that does not exist in our database, you will receive the following response:
Nonexistent API URL
Noneexistent ID
{
    "detail": "Member not found"
}
{
    "detail": "Member not found"
}
﻿
﻿
Error code
Description
422
Incorrect data structure or data types provided in the request.
422
Duplicate keys
{
  "detail": [
    {
      "loc": [
        "body"
      ],
      "msg": "Duplicate keys are not allowed within filters",
      "type": "value_error.duplicate"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "body"
      ],
      "msg": "Duplicate keys are not allowed within filters",
      "type": "value_error.duplicate"
    }
  ]
}
﻿
﻿
Error code
Description
429
Endpoint rate limit has been exceeded. 
Employee API endpoints restrict the number of requests allowed per second for each client's API token:
Employee API search endpoints
Employee API collection endpoints
Bulk Collect POST endpoints
Bulk Collect GET endpoints
Webhook endpoints
Allow 18 requests per second.
Allow 54 requests per second.
Allow 27 requests per second.
Allow 27 requests per second.
Allow 9 requests per second.
﻿
Error code
Description
5xx
One possible example is that the wrong request type was selected (POST/GET). 
Code 500 denotes server issues. 
502
Bad Gateway
Bad Gateway
﻿
﻿
Code
Explanation
503
Service is unavailable due to too many requests received by our API.
503
"Error": "Service is temporarily unavailable"
"Error": "Service is temporarily unavailable"
﻿
﻿
Bulk Collect response codes
The following codes are specific to the Bulk Collect endpoints.
Error code
Description
400
Indicates incorrectly formatted or oversized files or invalid data:
Several examples
{ 
 "detail": "File does not contain any data"
},
{ 
 "detail": "Unable to parse the file"
},
{
"detail": "File should consist of a single column"
},
{
"detail": "File contains invalid IDs"
}
{ 
 "detail": "File does not contain any data"
},
{ 
 "detail": "Unable to parse the file"
},
{
"detail": "File should consist of a single column"
},
{
"detail": "File contains invalid IDs"
}
﻿
Error code
Description
402
Insufficient credits. Reduce your request size or contact your account manager to get more credits.
Insufficient credits
{
    "detail": "Insufficient credits"
}
{
    "detail": "Insufficient credits"
}
﻿
Error code
Description
409
Duplicate POST requests were submitted.
409
{
    "detail": "Identical data request is already in progress."
}
{
    "detail": "Identical data request is already in progress."
}
﻿
Error code
Explanation
503
Bulk Collect allows you to download the prepared dataset as often as you like within 30 days of submitting the query.
After 30 days of query submission, the GET query will return a 503 response code with the following message:
503
"Error": "File has expired and is no longer available"
"Error": "File has expired and is no longer available"
﻿
﻿
Webhook response codes
The following codes are specific to the Webhook endpoints.
ID endpoint response codes
Error code
Description
400
Error codes indicating failures due to incorrectly formatted or oversized files or invalid data.
The error message differs based on the error:
Several examples
{ 
 "detail": "File does not contain any data"
},
{ 
 "detail": "File needs to be a CSV file"
},
{
"detail": "File needs to be smaller than 15MB"
},
{
"detail": "Unable to read the CSV file"
},
{
"detail": "File should consist of a single column"
},
{
"detail": "File contains invalid IDs"
},
{
"detail": "File contains incorrect IDs"
},
{
"detail": "File contains too many IDs"
}

{ 
 "detail": "File does not contain any data"
},
{ 
 "detail": "File needs to be a CSV file"
},
{
"detail": "File needs to be smaller than 15MB"
},
{
"detail": "Unable to read the CSV file"
},
{
"detail": "File should consist of a single column"
},
{
"detail": "File contains invalid IDs"
},
{
"detail": "File contains incorrect IDs"
},
{
"detail": "File contains too many IDs"
}
﻿
Error code
Description
422
The webhook URL you provided is invalid.
Insufficient credits
{
    "detail": "Provided webhook URL is not valid"
}
{
    "detail": "Provided webhook URL is not valid"
}
﻿
Error code
Description
401
No valid API bearer token {JWT} was provided. Check if your token is valid and try again.
Could not indentify the user
{
    "detail": "Could not identify user"
}
{
    "detail": "Could not identify user"
}
﻿
Error code
Description
5xx
Unable to create subscription due to a server error.
Could not indentify the user
{
    "detail": "Unable to create subscription"
}
{
    "detail": "Unable to create subscription"
}
﻿
Filer/ES DSL endpoint response codes
Error code
Description
400
The request was unacceptable, often due to a missing required parameter. 

The error message differs based on the error:
Several examples
{ 
 "Error": "Query validation failed: Failed to parse query [('IT Company' OR 'Labs']"
},
{ 
 "Error": "Query validation failed: failed to create query: [nested] failed to find nested object under path [member_experience_collection]"
},
{
"Error": "Query validation failed: [fuzzy] query doesn't support multiple fields, found [must] and [must]"
},
{
"Error": "Query validation failed: request does not support [query_string]"
},
{
  "Error": "Query validation failed: failed to create query: compile error" 
},
{ 
 "Error": "Failed to parse es dsl query"
},
{ 
 "Error": " Query results count exceeds allowed limit"
}

{ 
 "Error": "Query validation failed: Failed to parse query [('IT Company' OR 'Labs']"
},
{ 
 "Error": "Query validation failed: failed to create query: [nested] failed to find nested object under path [member_experience_collection]"
},
{
"Error": "Query validation failed: [fuzzy] query doesn't support multiple fields, found [must] and [must]"
},
{
"Error": "Query validation failed: request does not support [query_string]"
},
{
  "Error": "Query validation failed: failed to create query: compile error" 
},
{ 
 "Error": "Failed to parse es dsl query"
},
{ 
 "Error": " Query results count exceeds allowed limit"
}
﻿
Error code
Description
401
No valid API bearer token {JWT} was provided. Check if your token is valid and try again.
Could not indentify the user
{
    "detail": "Could not identify user"
}
{
    "detail": "Could not identify user"
}
﻿
Error code
Description
422
 There are two possible reasons for the 422 error code:
The webhook URL you provided is invalid
You have used incompatible filters (such as any date filter from search filters or ES DSL schema).
Incorrect webhook URL
Incompatible filters
{
    "detail": "Field '<date-field>' is not allowed in subscription filters/es_dsl"
}
{
    "detail": "Field '<date-field>' is not allowed in subscription filters/es_dsl"
}
﻿
﻿

Error code	Description
400	Request was unacceptable, often due to a missing required parameter. The error message differs based on the error:

Error code	Description
401	No valid API bearer token {JWT} was provided. Check if your token is valid and try again.
404	Nonexistent API URL: Using DBAPI instead of CDAPI in the API URL while making a request will result in a 404 error message. Nonexistent ID: Using a profile ID that does not exist in our database, you will receive the following response:

Error code	Description
422	Incorrect data structure or data types provided in the request.

Error code	Description
429	Endpoint rate limit has been exceeded. Employee API endpoints restrict the number of requests allowed per second for each client's API token:

Error code	Description
5xx	One possible example is that the wrong request type was selected (POST/GET). Code 500 denotes server issues.

Code	Explanation
503	Service is unavailable due to too many requests received by our API.

Error code	Description
400	Indicates incorrectly formatted or oversized files or invalid data:

Error code	Description
402	Insufficient credits. Reduce your request size or contact your account manager to get more credits.

Error code	Description
409	Duplicate POST requests were submitted.

Error code	Explanation
503	Bulk Collect allows you to download the prepared dataset as often as you like within 30 days of submitting the query. After 30 days of query submission, the GET query will return a 503 response code with the following message:

Error code	Description
400	Error codes indicating failures due to incorrectly formatted or oversized files or invalid data. The error message differs based on the error:

Error code	Description
422	The webhook URL you provided is invalid.

Error code	Description
401	No valid API bearer token {JWT} was provided. Check if your token is valid and try again.

Error code	Description
5xx	Unable to create subscription due to a server error.

Error code	Description
400	The request was unacceptable, often due to a missing required parameter. The error message differs based on the error:

Error code	Description
401	No valid API bearer token {JWT} was provided. Check if your token is valid and try again.

Error code	Description
422	There are two possible reasons for the 422 error code: The webhook URL you provided is invalid You have used incompatible filters (such as any date filter from search filters or ES DSL schema).

Authorization

Endpoints

Response Codes

﻿Employee API response codes﻿

﻿Bulk Collect response codes﻿

﻿Webhooks response codes﻿

Employee API endpoint response codes

Bulk Collect response codes

Webhook response codes

ID endpoint response codes

Filer/ES DSL endpoint response codes

Employee API response codes

Bulk Collect response codes

Webhooks response codes