API Reference

Errors

PagerTree uses conventional HTTP response code to indicate the success or failure of an API request. In general: codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a wrongly formatted object, etc.). Codes in the 5xx range indicate an error with PagerTree's servers (these are rare).

Most 4xx errors that could be handled programmatically (e.g. a bad format) include and error response that briefly explains the error.

Error CodeMeaningDescription
400Bad RequestThe request was unacceptable, often due to a syntax error.
401UnauthorizedA valid API key not provided.
403ForbiddenYou don't have access to the resource requested.
404Not FoundThe resource does not exist.
409ConflictThe request conflicts with another request (perhaps using the same id or key).
422Unprocessable EntityThe request was unacceptable, often due to a missing required parameter.
429Too Many RequestsToo many request hit the API too quickly. We recommend an exponential backoff.
500Internal Server ErrorSomething went wrong on PagerTree's servers. (These are rare.)

Handling Errors

When there is an error, PagerTree will respond with errors body to help you diagnose why the request failed. The errors body has the following format:

{
  "errors": [
    {
        "message": "title can't be blank"
    },
  ],
  "code": 422
}
Previous
Authentication