PaperpinPaperpin Docs
REST API

Errors and rate limits

Understand Paperpin REST API error codes, validation failures, rate-limit responses, and safe retry behavior.

Errors always use the following JSON shape:

{
  "error": {
    "code": "validation_error",
    "message": "Invalid group data."
  }
}
StatusCodeMeaning
400validation_errorInvalid request body, query value, cursor, or resource input.
400invalid_monitorA monitor does not have a valid watch area and cannot run.
401unauthorizedMissing, malformed, revoked, expired, or invalid API key.
402run_limit_reachedA manual run cannot be queued because the tenant run limit is reached.
404not_foundThe resource does not exist in the authenticated tenant.
409conflictA group with the same tenant-scoped name already exists.
429rate_limitedThe API key exceeded its request allowance.
500internal_errorPaperPin could not process the request.

Public API requests are limited per API key. Rate-limit responses include the standard PaperPin rate-limit headers. On 429, wait until the reset time indicated by the response headers before retrying; do not retry non-idempotent requests blindly.