List animals

curl --request GET \
  --url https://{organization}.rescueconsole.com/api/animals/animals \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{organization}.rescueconsole.com/api/animals/animals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{organization}.rescueconsole.com/api/animals/animals"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "results": [
    {
      "status": "<string>",
      "id": "<string>",
      "species": "dog",
      "intake_date": "2023-12-25",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "public_name": "<string>",
      "breed": "<string>",
      "variety": "<string>",
      "sex": "male",
      "dob_estimate": "2023-12-25",
      "current_location_unit_id": "<string>",
      "microchip_number": "<string>",
      "microchip_vendor": "<string>",
      "alt_names": [
        "<string>"
      ],
      "size": "small",
      "color_primary": "<string>",
      "color_secondary": "<string>",
      "pattern": "<string>",
      "coat_length": "<string>",
      "intake_source": "stray",
      "primary_vet_organization_id": "<string>",
      "altered": "yes",
      "altered_before_intake": true,
      "altered_on": "2023-12-25",
      "altered_veterinarian_person_id": "<string>",
      "altered_clinic_organization_id": "<string>",
      "adoption_fee_cents": 1,
      "is_public": true,
      "health_status": "<string>",
      "description": "<string>",
      "behavioral_traits": [
        "<string>"
      ],
      "medical_flags": [
        "<string>"
      ],
      "custom_fields": {},
      "outcome_person_id": "<string>",
      "outcome_date": "2023-12-25",
      "good_with_children": 1,
      "min_child_age": 9,
      "good_with_adults": "all",
      "good_with_seniors": 1,
      "good_with_dogs": 1,
      "good_with_cats": 1,
      "good_with_farm_animals": 1,
      "good_with_small_animals": 1,
      "good_with_birds": 1,
      "needs_fenced_yard": 1,
      "ok_in_apartment": 1,
      "needs_experienced_adopter": 1,
      "max_hours_alone": 12,
      "placement_notes": "<string>",
      "house_trained": 1,
      "crate_trained": 1,
      "leash_trained": 1,
      "declawed": 1,
      "fiv_positive": 1,
      "energy_level": "low",
      "indoor_outdoor": "indoor",
      "available_date": "2023-12-25",
      "special_needs_description": "<string>",
      "distinguishing_marks": "<string>",
      "sponsorship_allowed": true,
      "sponsorship_minimum_cents": 1,
      "sponsorship_details": "<string>",
      "previous_id": "<string>",
      "photo_file_id": "<string>",
      "tenant_id": "<string>",
      "pet_id": "<string>",
      "care_state": "in_care",
      "tags": [
        "<string>"
      ],
      "transfer_id": "<string>",
      "transfer_partner_name": "<string>"
    }
  ],
  "limit": 123,
  "offset": 123,
  "has_more": true,
  "total": 123
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

GET

api

animals

List animals

curl --request GET \
  --url https://{organization}.rescueconsole.com/api/animals/animals \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{organization}.rescueconsole.com/api/animals/animals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{organization}.rescueconsole.com/api/animals/animals"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "results": [
    {
      "status": "<string>",
      "id": "<string>",
      "species": "dog",
      "intake_date": "2023-12-25",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "public_name": "<string>",
      "breed": "<string>",
      "variety": "<string>",
      "sex": "male",
      "dob_estimate": "2023-12-25",
      "current_location_unit_id": "<string>",
      "microchip_number": "<string>",
      "microchip_vendor": "<string>",
      "alt_names": [
        "<string>"
      ],
      "size": "small",
      "color_primary": "<string>",
      "color_secondary": "<string>",
      "pattern": "<string>",
      "coat_length": "<string>",
      "intake_source": "stray",
      "primary_vet_organization_id": "<string>",
      "altered": "yes",
      "altered_before_intake": true,
      "altered_on": "2023-12-25",
      "altered_veterinarian_person_id": "<string>",
      "altered_clinic_organization_id": "<string>",
      "adoption_fee_cents": 1,
      "is_public": true,
      "health_status": "<string>",
      "description": "<string>",
      "behavioral_traits": [
        "<string>"
      ],
      "medical_flags": [
        "<string>"
      ],
      "custom_fields": {},
      "outcome_person_id": "<string>",
      "outcome_date": "2023-12-25",
      "good_with_children": 1,
      "min_child_age": 9,
      "good_with_adults": "all",
      "good_with_seniors": 1,
      "good_with_dogs": 1,
      "good_with_cats": 1,
      "good_with_farm_animals": 1,
      "good_with_small_animals": 1,
      "good_with_birds": 1,
      "needs_fenced_yard": 1,
      "ok_in_apartment": 1,
      "needs_experienced_adopter": 1,
      "max_hours_alone": 12,
      "placement_notes": "<string>",
      "house_trained": 1,
      "crate_trained": 1,
      "leash_trained": 1,
      "declawed": 1,
      "fiv_positive": 1,
      "energy_level": "low",
      "indoor_outdoor": "indoor",
      "available_date": "2023-12-25",
      "special_needs_description": "<string>",
      "distinguishing_marks": "<string>",
      "sponsorship_allowed": true,
      "sponsorship_minimum_cents": 1,
      "sponsorship_details": "<string>",
      "previous_id": "<string>",
      "photo_file_id": "<string>",
      "tenant_id": "<string>",
      "pet_id": "<string>",
      "care_state": "in_care",
      "tags": [
        "<string>"
      ],
      "transfer_id": "<string>",
      "transfer_partner_name": "<string>"
    }
  ],
  "limit": 123,
  "offset": 123,
  "has_more": true,
  "total": 123
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

Authorizations

Authorization

string

header

required

An API key from Settings, API keys. It starts with rc_live_.

Query Parameters

limit

integer

default:25

How many to return. 25 unless you say, 100 at most.

Required range: 1 <= x <= 100

offset

integer

default:0

How many to skip, for the next page.

Required range: x >= 0

sort

enum<string>

default:intake_date

Available options:

intake_date,

name,

species,

breed,

status,

dob_estimate,

created_at,

updated_at

dir

enum<string>

default:desc

Available options:

asc,

desc

status

string

One or more of your own status keys, comma separated.

Example:

"available_for_adoption,adoption_pending"

care_state

enum<string>

Every status of one kind: in your care, placed, or out of your care.

Available options:

in_care,

placed,

out_of_care

species

string

One or more species, comma separated. A common word for a species (Dogs, Kitten) finds the same animals as its key.

Example:

"dog,cat"

location_unit_id

string

Animals housed at one location or unit.

tag

string

Animals carrying this tag, exactly as written.

age_band

string

One of your age groups (baby, young, adult and senior unless you have changed them) or unknown for animals with no date of birth. When exactly one species is asked for, that species' own age groups are used.

string

Text found in the name, breed, microchip number or Pet ID.

outcome_person_id

string

Animals whose outcome names this person, such as their adopter.

name

string

Animals whose internal name contains this text.

pet_id

string

Animals whose Pet ID contains this text.

breed

string

Animals whose breed contains this text.

sex

string

Sex, one or more, comma separated.

Example:

"male,female"

altered

string

Spayed or neutered: yes, no or unknown, one or more, comma separated.

Example:

"yes,no"

size

string

Size (small, medium, large, extra_large), one or more, comma separated.

Example:

"small,medium"

intake_source

string

Intake source (stray, transfer, owner_surrender, field, born_in_care, adoption_return, seized, other), one or more, comma separated.

Example:

"stray,transfer"

health_status

string

Animals whose health status contains this text.

microchip_number

string

Animals whose microchip number contains this text.

description

string

Animals whose description contains this text.

is_public

enum<string>

Whether the animal itself is marked public.

Available options:

yes,

no

intake_date_from

string<date>

Intake date on or after this date.

intake_date_to

string<date>

Intake date on or before this date.

outcome_date_from

string<date>

Outcome date on or after this date.

outcome_date_to

string<date>

Outcome date on or before this date.

dob_estimate_from

string<date>

Date of birth on or after this date.

dob_estimate_to

string<date>

Date of birth on or before this date.

created_at_from

string<date>

Created on or after this date. This one holds a time as well as a date, so a _to date stops before that day begins: send the next day to include it.

created_at_to

string<date>

Created on or before this date. This one holds a time as well as a date, so a _to date stops before that day begins: send the next day to include it.

updated_at_from

string<date>

Last changed on or after this date. This one holds a time as well as a date, so a _to date stops before that day begins: send the next day to include it.

updated_at_to

string<date>

Last changed on or before this date. This one holds a time as well as a date, so a _to date stops before that day begins: send the next day to include it.

adoption_fee_cents_min

integer

Adoption fee of at least this many cents.

adoption_fee_cents_max

integer

Adoption fee of at most this many cents.

include_deleted

enum<string>

Send 1 to include deleted animals.

Available options:

1

Response

One page of animals.

results

object[]

required

Show child attributes

limit

integer

required

offset

integer

required

has_more

boolean

required

Whether there is another page after this one.

total

integer

required

How many animals match in all.

Using the API

Endpoints

List animals

Authorizations

Query Parameters

Response