...

On 10/5/19 we released a major update to the v5 API.  Please see the notes below.

On 1/24/20 we released a minor update to the v5 API.  This update involved mostly changes to the backend.  Please see the notes below.

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.

...

Improvements/changes made with the update on 10/5/19

• If an attribute or relationship doesn't exist (ie., is null), that element will no longer be returned in the result. This will result in smaller results transfer sizes and make it easier to read and understand result data.
• Compression (gzip) has been enabled on the API server.
• All entity meta properties are now returned as entity attributes. Meta is only provided at the top-level of the response data.
• The top-level meta data now includes more information about the request and results, including a transactionId that can be used when requesting assistance from RescueGroups.org.
• We're simplifying the API by removing endpoints that weren't being used.
• Endpoints are now grouped in the documentation so that all endpoints of the same type (eg., animals) are together.

Improvements/changes made with the update on 1/24/20

• Geolocation now accepts postalcode, coordinates, or lat and lon in order to calculate distance for animals and organizations. Refer to the Endpoint reference for more information about how to perform a distance query for animals or organizations.

Swagger definition available

Coming soon!  You can download an early draft of our Swagger definition for the public API animals endpoint: https://test1-api.rescuegroups.org/v5/public/swagger.phpendpoints.

To open the definition go to the Swagger Editor and click File > Import URL and paste the URL above, once it's available.

Postman collection available

...

...

We

...

We also have a public Postman collection available to help you with examples.

...