PawFinder Service API

Connecting paws with people

© 2025. RJ Rodriguez. All rights reserved.

PawFinder paws image

/shelters resource

This resource represents animal shelters and rescue organizations in the PawFinder network. Use this endpoint to manage shelter profiles, display shelter contact information and operating hours, and track facility details like location and pet availability numbers. Shelters must register before adding pet profiles, visit the /pets resource for pet profile management details.

Base endpoint:

# Recommended base_url = http://localhost:3000
{base_url}/shelters

/shelters map

graph TD
    A["Shelters Resource<br/>{base_url}/shelters"]
    
    A -->|GET| B["Get all shelter profiles<br/>GET /shelters"]
    A -->|GET| C["Get shelter by ID<br/>GET /shelters/{id}"]
    
    A -->|POST| D["Create shelter profile<br/>POST /shelters"]
    
    A -->|PATCH| E["Partial update<br/>PATCH /shelters/{id}"]
    
    A -->|PUT| F["Replace shelter<br/>PUT /shelters/{id}"]
    
    A -->|DELETE| G["Delete shelter<br/>DELETE /shelters/{id}"]
    
    style A fill:#88b2c4,stroke:#333,stroke-width:2px,color:#fff
    style B fill:#9989c4,stroke:#333,stroke-width:2px,color:#fff
    style C fill:#9989c4,stroke:#333,stroke-width:2px,color:#fff
    style D fill:#9989c4,stroke:#333,stroke-width:2px,color:#fff
    style E fill:#cc848a,stroke:#333,stroke-width:2px,color:#000
    style F fill:#cc848a,stroke:#333,stroke-width:2px,color:#000
    style G fill:#cc848a,stroke:#333,stroke-width:2px,color:#000

Shelter profile object fields

Property Type Description Value Format
name string Shelter’s name Any text
address string Shelter’s location information Any text
phone string Shelter’s phone number E.164 format: “+1-XXX-XXX-XXXX”
email string Shelter’s email address Any text
hours string Shelter’s hours of operation Any text
available_pet_count integer Shelter’s available pets Numeric value
adoption_fee_range string Shelter’s fee range United States Dollars
id integer Shelter’s unique identifier Auto-generated, read-only

Example shelter profile object

{
  "name": "Dallas Animal Services",
  "address": "1818 N Westmoreland Rd, Dallas, TX 75212",
  "phone": "+1-214-671-0249",
  "email": "info@dallasanimalservices.org",
  "hours": "Mon-Sat 11:00-18:00",
  "available_pet_count": 22,
  "adoption_fee_range": "75-200",
  "id": 1
}

Operations

Authentication

GET requests don’t require authentication. Write operations POST, PUT, PATCH, and DELETE require an API token. Visit the Authentication Guide for instructions and security best practices.