Page History
...
We also have a public Postman collection available to help you with samples and examples.
Common questions
...
We don't have any ETA for production release yet. We are hoping that it will be in production by the middle of mid-2018.
Question: Will the current APIs (v2 and the REST API) be deprecated?
Yes, we expect to discontinue use of the current APIs as some time after v5 goes live. We will provide plenty of notice beforehand. We expect to have multiple APIs running in production for a year or more.
Examples
We will be adding examples and improving the Swagger definition as time allows.
Search with advanced filters
Return one random available 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 |
POST Body:
| 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:
...
| collapse | true |
|---|
...
Overview
Content Tools