PawFinder Service API

PawFinder API Documentation

Connect paws to people with the PawFinder REST API. Integrate adoptable pet data into apps, websites, and services to help families find their perfect match.

Documentation structure

Different sections serve different needs:

Section	Best for	Contents
Start here	First-time setup, contributors	Overview, installation, authentication, first API call, report issues
API Reference	Looking up endpoints	Complete schemas and operations
Tutorials	Task-based learning	Add pets, filter results, manage shelter data

Start here

• Overview
  Learn key concepts. Discover how different development audiences use the API.
• Installation Guide
  Set up the development environment for hands-on tutorials.
• Authentication Guide
  Create API tokens for write operations.
• Quickstart Guide
  Make a GET request to /pets and view annotated JSON examples.
• Contribution Guide
  Report issues and suggest improvements.

API reference

• API Index
  Reference all endpoint operations, parameters, and responses.
• /pets resource
  • GET /pets?{query_parameters}
    Search and filter pet profiles.
  • GET /pets/{id}
    Access detailed information for a specific pet.
• /shelters resource
  • GET /shelters
    Retrieve the profiles of all participating shelters.
  • GET /shelters/{id}
    Fetch detailed shelter information and contact details.

Tutorials

• API Fundamentals
  • Find the Perfect Pet
    Filter pet profiles by species, breed, and other criteria.
  • Mark Pets as Adopted
    Update a pet profile when finalizing adoptions.
  • Track Adoption Status
    Follow pet availability and adoption status in real-time.
• Building Applications
  • Build a Location-Aware Search
    Apply proximity filtering and distance calculations.

Get help

PawFinder is a documentation portfolio project. Status monitoring and support channels shown below represent production-ready patterns. The GitHub issues link is functional.

• Check real-time API status at status.pawfinder.com
• Found an error or have a suggestion? Report it here.
• Need help integrating? Contact support@pawfinder.com