Page History
...
Version 5 of the RescueGroups.org API is currently under development. We released on 2/15/18 a very early release (consider it an alpha developer preview) of only the Animals endpoint.
This API will change in the coming months. We would greatly appreciate your feedback and ideas for improvement. However, perform development at your own risk. We would expect changes to be relatively minor, but there's no guarantee.
Changes and improvements of note
...
To open the definition go to the Swagger Editor and click File > Import URL and paste the URL above.
Examples
...
We will be adding examples and improving the Swagger definition as time allows.
Search with advanced filters
Return one random available animal cat within 100 miles of 20697. This request includes all related objects and all available fields, so it's a bit overwhelming.
Method: POST
Header: Authorization: (your API Key)
URL:
| Code Block | ||
|---|---|---|
| ||
https://test-api.rescuegroups.org/v5/public/animals/search/?include=breeds,colors,fosters,locations,orgs,patterns,pictures,species,statuses,videos,videourls&fields[animals]=activityLevel,adoptedDate,adoptionFeeString,isAdoptionPending,adultSexesOk,ageGroup,isAltered,availableDate,birthDate,isBirthDateExact,breedId,breedString,breedPrimary,breedPrimaryId,breedSecondary,breedSecondaryId,isBreedMixed,isCatsOk,coatLength,color,colorId,isCourtesyListing, createdDate,isCurrentVaccinations,isDeclawed,descriptionHtml,descriptionText,distinguishingMarks,isDogsOk,earType,exerciseNeeds,eyeColor,fenceNeeds,isNeedingFoster,isFound,foundDate,foundPostalcode,groomingNeeds,isHousetrained,housetrainedReasonNot,indoorOutdoor, isKidsOk,killDate,killReason,isMicrochipped,name,newPeopleReaction,obedienceTraining,ownerExperience,pattern,patternId,priority,rescueId,searchString,sex,sheddingLevel,sizeGroup,sizePotential,sizeCurrent,sizeUOM,isSpecialNeeds,specialNeedsDetails,species,speciesId,isSponsorable,sponsors,sponsorshipDetails,sponsorshipMinimum,summary,tailType,updatedDate,vocalLevel,isYardRequired,qualities&fields[orgs]=name,street,city,state,citystate,postalcode,postalcodePlus4,country,phone,fax,email,url,facebookUrl,adoptionUrl,donationUrl,sponsorshipUrl,serveAreas,adoptionProcess,about,services,meetPets,type,isCommonapplicationAccepted&fields[breeds]=name&fields[colors]=name&fields[fosters]=salutation,email,firstname,lastname,phoneHome,phoneCell&fields[locations]=name,street,city,state,postalcode,country,url,phone,phoneExt&fields[patterns]=name&fields[pictures]=created,updated,original,large,small&fields[species]=singular,plural,youngSingular,youngPlural&fields[statuses]=name&fields[videos]=fileSize,url&fields[videourls]=url,videoId,urlThumbnail&options=meta&sort=random&limit=1 |
...
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"filters": [
{
"fieldName": "statuses.name",
"operation": "equals",
"criteria": "Available"
},
{
"fieldName": "species.singular",
"operation": "equals",
"criteria": "Cat"
}
],
"filterRadius":
{
"miles": 100,
"postalcode": 20697
}
}
} |
Get one animal
Return one specific animal by ID.
Method: GET
Header: Authorization: (your API Key)
URL:
| Code Block | ||
|---|---|---|
| ||
{{url}}/public/animals/11557194?include=breeds,colors,fosters,locations,orgs,patterns,pictures,species,videos,videourls&fields[animals]=name,sex&fields[orgs]=name,email,url,facebookUrl,adoptionUrl&fields[breeds]=name&fields[colors]=name&fields[fosters]=name,email&fields[locations]=name&fields[patterns]=name&fields[pictures]=large,small&fields[species]=singular&fields[videos]=url&fields[videourls]=url,urlThumbnail&options=meta |
Overview
Content Tools