Get one animal

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

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

fetch('https://{organization}.rescueconsole.com/api/animals/animals/{id}', 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/{id}"

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

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

print(response.text)

{
  "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>"
}

{
  "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

{id}

Get one animal

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

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

fetch('https://{organization}.rescueconsole.com/api/animals/animals/{id}', 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/{id}"

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

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

print(response.text)

{
  "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>"
}

{
  "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_.

Path Parameters

string

required

The animal's record ID (not its Pet ID).

Response

The animal.

What can be written only by changing an animal: the home it needs, its listing details and its outcome.

status

string

required

One of your own status keys.

string

required

species

enum<string>

required

Available options:

dog,

cat,

rabbit,

equine,

small_mammal,

large_mammal,

bird,

barnyard,

fish,

reptile,

exotic

intake_date

string<date>

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

name

string | null

The internal name.

public_name

string | null

The external name: printed, and shown on your public site and listing sites. Null uses the internal name.

breed

string | null

The breed. For a small mammal, bird, reptile, fish, farm animal, large mammal or exotic, the KIND of animal: Guinea pig, Cockatiel.

variety

string | null

The breed or variety beside a kind: Abyssinian.

Maximum string length: 60

sex

enum<string> | null

Available options:

male,

female,

unknown,

null

dob_estimate

string<date> | null

The date of birth, or the best estimate of it.

current_location_unit_id

string | null

Where the animal is housed: a location or unit ID. Null clears it.

microchip_number

string | null

microchip_vendor

string | null

Maximum string length: 60

alt_names

string[]

Other names the animal is known by. Replaced whole when sent; blanks and repeats are dropped.

Maximum array length: 10

Maximum string length: 60

size

enum<string> | null

Available options:

small,

medium,

large,

extra_large,

null

color_primary

string | null

Your own words.

Maximum string length: 60

color_secondary

string | null

Your own words.

Maximum string length: 60

pattern

string | null

Your own words.

Maximum string length: 60

coat_length

string | null

Your own words.

Maximum string length: 60

intake_source

enum<string> | null

Available options:

stray,

transfer,

owner_surrender,

field,

born_in_care,

adoption_return,

seized,

other,

null

primary_vet_organization_id

string | null

The animal's usual vet: an organization on file.

altered

enum<string> | null

Spayed or neutered.

Available options:

yes,

no,

unknown,

null

altered_before_intake

boolean | null

Whether it was spayed or neutered before it came to you.

altered_on

string<date> | null

When it was spayed or neutered.

altered_veterinarian_person_id

string | null

The vet who did it: a person on file.

altered_clinic_organization_id

string | null

Where it was done: an organization on file.

adoption_fee_cents

integer | null

The adoption fee, in cents. Null is no fee set, which is a different fact from a fee of 0.

Required range: x >= 0

is_public

boolean

Whether the animal itself is marked public. Your public site and listings show it only when its status is public too.

health_status

string | null

Health. When you write it, one of: healthy, minor_issue, under_treatment, recovering, chronic_condition, special_needs, critical, hospice. An older record may still hold words from before that list.

description

string | null

The description your public listing shows and a cage card can print.

behavioral_traits

string[]

Replaced whole when sent.

medical_flags

string[]

The animal's medical conditions, by name. Replaced whole when sent.

custom_fields

object

Your organization's own fields, by field key. Each value must suit its field. On a change, the keys you send are merged into what is stored, and a key sent as null is removed.

outcome_person_id

string | null

Who the animal left with, such as its adopter: a person on file. Null clears it.

outcome_date

string<date> | null

When the animal left your care.

good_with_children

enum<integer> | null

1 is yes, 0 is no, and null is NOT ASSESSED, which is a different fact from no.

Available options:

1,

0,

null

min_child_age

integer | null

The youngest child age, only when good_with_children is 1. Refused beside a good_with_children of 0.

Required range: 0 <= x <= 18

good_with_adults

enum<string> | null

Which adults the animal is good with. Null is not assessed.

Available options:

all,

men_only,

women_only,

null

good_with_seniors

enum<integer> | null

1 is yes, 0 is no, and null is NOT ASSESSED, which is a different fact from no.

Available options:

1,

0,

null

good_with_dogs

enum<integer> | null

1 is yes, 0 is no, and null is NOT ASSESSED, which is a different fact from no.

Available options:

1,

0,

null

good_with_cats

enum<integer> | null

1 is yes, 0 is no, and null is NOT ASSESSED, which is a different fact from no.

Available options:

1,

0,

null

good_with_farm_animals

enum<integer> | null

1 is yes, 0 is no, and null is NOT ASSESSED, which is a different fact from no.

Available options:

1,

0,

null

good_with_small_animals

enum<integer> | null

1 is yes, 0 is no, and null is NOT ASSESSED, which is a different fact from no.

Available options:

1,

0,

null

good_with_birds

enum<integer> | null

1 is yes, 0 is no, and null is NOT ASSESSED, which is a different fact from no.

Available options:

1,

0,

null

needs_fenced_yard

enum<integer> | null

1 is yes, 0 is no, and null is NOT ASSESSED, which is a different fact from no.

Available options:

1,

0,

null

ok_in_apartment

enum<integer> | null

1 is yes, 0 is no, and null is NOT ASSESSED, which is a different fact from no.

Available options:

1,

0,

null

needs_experienced_adopter

enum<integer> | null

1 is yes, 0 is no, and null is NOT ASSESSED, which is a different fact from no.

Available options:

1,

0,

null

max_hours_alone

integer | null

The most hours the animal can be left alone.

Required range: 0 <= x <= 24

placement_notes

string | null

What a home needs to know, in your own words.

house_trained

enum<integer> | null

1 is yes, 0 is no, and null is NOT ASSESSED, which is a different fact from no.

Available options:

1,

0,

null

crate_trained

enum<integer> | null

1 is yes, 0 is no, and null is NOT ASSESSED, which is a different fact from no.

Available options:

1,

0,

null

leash_trained

enum<integer> | null

1 is yes, 0 is no, and null is NOT ASSESSED, which is a different fact from no.

Available options:

1,

0,

null

declawed

enum<integer> | null

1 is yes, 0 is no, and null is NOT ASSESSED, which is a different fact from no.

Available options:

1,

0,

null

fiv_positive

enum<integer> | null

1 is FIV positive, 0 is negative, and null is not tested.

Available options:

1,

0,

null

energy_level

enum<string> | null

Available options:

low,

moderate,

high,

null

indoor_outdoor

enum<string> | null

Available options:

indoor,

both,

outdoor,

null

available_date

string<date> | null

The date the animal is available from.

special_needs_description

string | null

Maximum string length: 2000

distinguishing_marks

string | null

Maximum string length: 2000

sponsorship_allowed

boolean

Whether you take sponsors for this animal. True or false, never null.

sponsorship_minimum_cents

integer | null

The smallest sponsorship, in cents.

Required range: x >= 0

sponsorship_details

string | null

Maximum string length: 2000

previous_id

string | null

The animal's ID in another system.

Maximum string length: 60

photo_file_id

string | null

The ID of the animal's profile photo. Null removes the photo. A photo is added from RescueConsole itself.

tenant_id

string

Your organization's ID.

pet_id

string | null

The ID your organization's format gave it, such as A00042. Null when Pet IDs are switched off.

care_state

enum<string>

What kind of status it is in.

Available options:

in_care,

placed,

out_of_care

Using the API

Endpoints

Get one animal

Authorizations

Path Parameters

Response