API Index

http://localhost:3000

Reference topics

Resources

/pets operations

/shelters operations

Common error responses for all endpoints

429 Too Many Requests - reaching rate limit

{
  "error": "Too Many Requests",
  "message": "Rate limit exceeded. Try again in 60 seconds",
  "status": 429,
  "retry_after": 60
}

500 Internal Server Error - something is wrong with the server

{
  "error": "Internal Server Error",
  "message": "An unexpected error occurred. Please try again later",
  "status": 500
}

503 Service Unavailable - during PawFinder Maintenance

{
  "error": "Service Unavailable",
  "message": "API is temporarily unavailable for maintenance",
  "status": 503
}

Versioning

The PawFinder API currently doesn’t use URI versioning, but plans to.

Future version support policy: