curl --request GET \
--url https://{organization}.rescueconsole.com/api/animals/applications \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/animals/applications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/applications"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"id": "<string>",
"applicant_person_id": "<string>",
"status": "draft",
"is_open": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"co_applicant_name": "<string>",
"co_applicant_email": "<string>",
"co_applicant_phone": "<string>",
"housing_type": "house",
"housing_is_rented": true,
"landlord_name": "<string>",
"landlord_phone": "<string>",
"landlord_approves": true,
"has_fenced_yard": true,
"household_adults": 1,
"household_children": 1,
"youngest_child_age": 1,
"household_agrees": true,
"has_current_pets": true,
"current_pets": "<string>",
"has_previous_pets": true,
"previous_pets": "<string>",
"vet_name": "<string>",
"vet_phone": "<string>",
"hours_alone_per_day": 12,
"meet_scheduled_at": "<string>",
"meet_location": "<string>",
"meet_completed_at": "<string>",
"meet_notes": "<string>",
"decision_notes": "<string>",
"application_kind": "adoption",
"stage": "<string>",
"stage_label": "<string>",
"submitted_on": "2023-12-25",
"decided_on": "2023-12-25",
"decided_by_person_id": "<string>",
"decision_reason_code": "housing_unsuitable",
"held_at": "2023-11-07T05:31:56Z",
"hold_reason": "<string>",
"meet_with": [
{
"person_id": "<string>",
"name": "<string>"
}
],
"source_submission_id": "<string>",
"custom_fields": {},
"applicant_first_name": "<string>",
"applicant_last_name": "<string>",
"applicant_name": "<string>",
"applicant_email": "<string>",
"pet_count": 123,
"assignees": [
{
"person_id": "<string>",
"name": "<string>"
}
],
"pets": [
{
"animal_id": "<string>",
"rank": 123,
"id": "<string>",
"name": "<string>",
"species": "dog",
"status": "<string>",
"breed": "<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)"
}List applications
One page of applications: the open ones first, then the rest, each newest first by the date it was submitted (or made). Needs read on Animals.
curl --request GET \
--url https://{organization}.rescueconsole.com/api/animals/applications \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/animals/applications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/applications"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"id": "<string>",
"applicant_person_id": "<string>",
"status": "draft",
"is_open": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"co_applicant_name": "<string>",
"co_applicant_email": "<string>",
"co_applicant_phone": "<string>",
"housing_type": "house",
"housing_is_rented": true,
"landlord_name": "<string>",
"landlord_phone": "<string>",
"landlord_approves": true,
"has_fenced_yard": true,
"household_adults": 1,
"household_children": 1,
"youngest_child_age": 1,
"household_agrees": true,
"has_current_pets": true,
"current_pets": "<string>",
"has_previous_pets": true,
"previous_pets": "<string>",
"vet_name": "<string>",
"vet_phone": "<string>",
"hours_alone_per_day": 12,
"meet_scheduled_at": "<string>",
"meet_location": "<string>",
"meet_completed_at": "<string>",
"meet_notes": "<string>",
"decision_notes": "<string>",
"application_kind": "adoption",
"stage": "<string>",
"stage_label": "<string>",
"submitted_on": "2023-12-25",
"decided_on": "2023-12-25",
"decided_by_person_id": "<string>",
"decision_reason_code": "housing_unsuitable",
"held_at": "2023-11-07T05:31:56Z",
"hold_reason": "<string>",
"meet_with": [
{
"person_id": "<string>",
"name": "<string>"
}
],
"source_submission_id": "<string>",
"custom_fields": {},
"applicant_first_name": "<string>",
"applicant_last_name": "<string>",
"applicant_name": "<string>",
"applicant_email": "<string>",
"pet_count": 123,
"assignees": [
{
"person_id": "<string>",
"name": "<string>"
}
],
"pets": [
{
"animal_id": "<string>",
"rank": 123,
"id": "<string>",
"name": "<string>",
"species": "dog",
"status": "<string>",
"breed": "<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
An API key from Settings, API keys. It starts with rc_live_.
Query Parameters
How many to return. 50 unless you say, 200 at most.
1 <= x <= 200How many to skip, for the next page.
x >= 0One stage key, such as assigned. An application with no stage is found by its status. An application at a stage is found by the stage's key, not by the status the stage belongs to.
true for only the applications still open: not approved, denied or withdrawn.
true me for the applications assigned to the person who made the key; nobody for the ones assigned to nobody.
me, nobody One applicant's applications.
The applications for one animal.
One kind of home.
house, apartment, condo, townhouse, mobile_home, farm, other Part of the applicant's first name, last name or email.