Errors

Learn how to interpret API error responses.

Pliro's API uses standard HTTP status codes to indicate the success or failure of a request. Codes in the 200-299 range indicate success, codes in the 400-499 range indicate a client error (e.g., omitting a required parameter or not providing a valid API token), and codes in the 500-599 range indicate an error with Pliro's servers (these should be rare).

All error responses include an error object:

$ curl -G $PLIRO_API_BASE_URL/2023-04-11/customers \
  -u $PLIRO_API_KEY: \
  -d limit=0
{
  "error": {
    "code": "invalid_param",
    "message": "limit must be greater than or equal to 1 but was 0."
  }
}

The error object

{
  "code": "invalid_param",
  "message": "limit must be greater than or equal to 1 but was 0."
}

Properties

code string A short string identifying the error. See error codes for a full list of possible codes.

message string A message providing more details about the error.