Response Codes

Overview

Explore the various possible response codes and their meanings.

These error codes can be encountered in all:

Search and collect response codes

Codes received with Elasticsearch DSL, Search filters, and Collect endpoints

Bulk Collect response codes

Codes received with Bulk Collect endpoints

Webhook (subscriptions) response codes

Codes received with Webhook subscription endpoints

Real-time Employee API response codes

Codes received with Real-time Employee API endpoint

Search and collect response codes

Bulk Collect response codes

Subscriptions response codes

ID endpoint response codes

Search Filter and ES DSL endpoint response codes

Request code	Description
200	A successful request
400	The request was unacceptable, often due to a missing required parameter.
401	No valid API Key was provided. Check if your key is valid and try again.
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 Elasticsearch DSL schema).

Real-time Employee API response codes

200	A successful request. Credits are deducted.
400	The request was unacceptable, often due to a missing required parameter.
402	Insufficient credits
408	Response timeout. Credits have not been deducted for this request. You can try sending the request again.
422	Incorrect data structure or data types were provided in the request. Unprocessable content Invalid URL Invalid cache age
453	Employee profile data is unavailable due to a privacy request to delete the data from our database.
503	Something went wrong on the API side. You will get a Bad gateway error message if you have selected the wrong request type.