HTTP status codes

All responses from the REST API include a response status code. The codes most often used in the REST API are described below.

  • 200—Success
    Your query was valid, and appropriate output is being provided.
  • 400—Invalid query
    Something about your query was erroneous—perhaps an invalid option or combination of options. A descriptive error message is provided in the response body.
  • 401—Authentication needed
    You will see this response code if your query did not contain a bearer token or if the token you provided is invalid or expired. You should obtain a new token with a valid Login call and then resubmit your query using that token.
  • 403—Forbidden
    The current user does not have authorization to perform the requested action. Either the user ID does not have permission to use the REST API, or perhaps the assigned role for the user ID is not allowed access to the requested resource. For more information, see Resource Permissions.
  • 500—A server error of some kind occurred. Contact How to get Support.
  • 503—Server busy
    To ensure maximum performance for all REST API users, the REST API server enforces limits on your account's use of the API. If your API use is excessive, the server returns a 503 status code. For more information, see REST API Service Limits.

HTTP Responses other than 200 will also provide the link to the REST API Documentation.