Create an application
curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/applications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"applicant_person_id": "b7e4c1d2-5a3f-4e8b-9c6d-1f2a3b4c5d6e",
"status": "submitted",
"animal_ids": [
"0c9d8e7f-6a5b-4c3d-9e1f-0a9b8c7d6e5f"
],
"housing_type": "house",
"housing_is_rented": true,
"landlord_name": "Contoso Property Management",
"landlord_phone": "555-0142",
"has_fenced_yard": true,
"household_adults": 2,
"household_children": 1,
"youngest_child_age": 9,
"has_current_pets": true,
"current_pets": "One spayed cat, six years old",
"hours_alone_per_day": 6
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
applicant_person_id: 'b7e4c1d2-5a3f-4e8b-9c6d-1f2a3b4c5d6e',
status: 'submitted',
animal_ids: ['0c9d8e7f-6a5b-4c3d-9e1f-0a9b8c7d6e5f'],
housing_type: 'house',
housing_is_rented: true,
landlord_name: 'Contoso Property Management',
landlord_phone: '555-0142',
has_fenced_yard: true,
household_adults: 2,
household_children: 1,
youngest_child_age: 9,
has_current_pets: true,
current_pets: 'One spayed cat, six years old',
hours_alone_per_day: 6
})
};
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"
payload = {
"applicant_person_id": "b7e4c1d2-5a3f-4e8b-9c6d-1f2a3b4c5d6e",
"status": "submitted",
"animal_ids": ["0c9d8e7f-6a5b-4c3d-9e1f-0a9b8c7d6e5f"],
"housing_type": "house",
"housing_is_rented": True,
"landlord_name": "Contoso Property Management",
"landlord_phone": "555-0142",
"has_fenced_yard": True,
"household_adults": 2,
"household_children": 1,
"youngest_child_age": 9,
"has_current_pets": True,
"current_pets": "One spayed cat, six years old",
"hours_alone_per_day": 6
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"application": {
"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>"
}
]
}
}{
"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)"
}Adoption applications
Create an application
Records an application for a person already on file. Only the applicant is required. The applicant is given the adopter role (the foster role for a foster application), and any workflow your organization starts when an application is created starts. Needs write on Animals.
POST
/
api
/
animals
/
applications
Create an application
curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/applications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"applicant_person_id": "b7e4c1d2-5a3f-4e8b-9c6d-1f2a3b4c5d6e",
"status": "submitted",
"animal_ids": [
"0c9d8e7f-6a5b-4c3d-9e1f-0a9b8c7d6e5f"
],
"housing_type": "house",
"housing_is_rented": true,
"landlord_name": "Contoso Property Management",
"landlord_phone": "555-0142",
"has_fenced_yard": true,
"household_adults": 2,
"household_children": 1,
"youngest_child_age": 9,
"has_current_pets": true,
"current_pets": "One spayed cat, six years old",
"hours_alone_per_day": 6
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
applicant_person_id: 'b7e4c1d2-5a3f-4e8b-9c6d-1f2a3b4c5d6e',
status: 'submitted',
animal_ids: ['0c9d8e7f-6a5b-4c3d-9e1f-0a9b8c7d6e5f'],
housing_type: 'house',
housing_is_rented: true,
landlord_name: 'Contoso Property Management',
landlord_phone: '555-0142',
has_fenced_yard: true,
household_adults: 2,
household_children: 1,
youngest_child_age: 9,
has_current_pets: true,
current_pets: 'One spayed cat, six years old',
hours_alone_per_day: 6
})
};
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"
payload = {
"applicant_person_id": "b7e4c1d2-5a3f-4e8b-9c6d-1f2a3b4c5d6e",
"status": "submitted",
"animal_ids": ["0c9d8e7f-6a5b-4c3d-9e1f-0a9b8c7d6e5f"],
"housing_type": "house",
"housing_is_rented": True,
"landlord_name": "Contoso Property Management",
"landlord_phone": "555-0142",
"has_fenced_yard": True,
"household_adults": 2,
"household_children": 1,
"youngest_child_age": 9,
"has_current_pets": True,
"current_pets": "One spayed cat, six years old",
"hours_alone_per_day": 6
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"application": {
"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>"
}
]
}
}{
"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_.
Body
application/json
The answers on an application. Send only what changes. A yes or no answer is true, false, or null for not asked. Text is trimmed, and empty text is stored as null.
The person applying. They are given the adopter role, or the foster role for a foster application, if they do not have it yet.
A second adult applying with them. Kept on the application, not as a person record.
Available options:
house, apartment, condo, townhouse, mobile_home, farm, other, null Whether they rent their home.
Whether the landlord agrees. Null means nobody has asked the landlord yet, which is not the same as no.
How many adults live in the home.
Required range:
x >= 0How many children live in the home.
Required range:
x >= 0The age of the youngest child, in years.
Required range:
x >= 0Whether everyone in the home agrees to the adoption.
Whether they have pets now.
The pets they have now, in their words.
Whether they have had pets before.
The pets they have had, in their words.
Their veterinarian.
How many hours a day the animal would be alone.
Required range:
0 <= x <= 24When the meet and greet is: a date, or a date and time such as 2026-10-03T14:00.
Where the meet and greet is.
When the meet and greet took place.
How the meet and greet went.
Notes on the decision.
Available options:
adoption, foster An application cannot be created approved or denied: create it, then record the decision.
Available options:
draft, submitted, under_review, meet_scheduled, withdrawn When it was submitted, for an application entered from paper. Today unless you say. Ignored for a draft.
The animals applied for, in order of preference: the first is the one they most want.
Your own application questions, by field key. Every question marked required must be answered.
Response
The application, as it was created.
The answers on an application. Send only what changes. A yes or no answer is true, false, or null for not asked. Text is trimmed, and empty text is stored as null.
Show child attributes
Show child attributes