List signed contracts
curl --request GET \
--url https://{organization}.rescueconsole.com/api/animals/contracts \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/animals/contracts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/contracts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"id": "<string>",
"contract_name": "<string>",
"contract_version": "<string>",
"signer_name": "<string>",
"signed_at": "2023-11-07T05:31:56Z",
"entity_type": "adoption",
"entity_id": "<string>",
"is_voided": true,
"template_id": "<string>",
"contract_body": "<string>",
"contract_body_blocks": [
{
"type": "p",
"runs": [
{
"text": "<string>",
"bold": true,
"italic": true,
"underline": true,
"strike": true,
"href": "<string>"
}
],
"items": [
[
{
"text": "<string>",
"bold": true,
"italic": true,
"underline": true,
"strike": true,
"href": "<string>"
}
]
],
"level": 1,
"rows": [
[
[
{
"text": "<string>",
"bold": true,
"italic": true,
"underline": true,
"strike": true,
"href": "<string>"
}
]
]
],
"src": "<string>",
"alt": "<string>"
}
],
"signer_person_id": "<string>",
"signer_email": "<string>",
"consent_acknowledged": true,
"recorded_by_person_id": "<string>",
"media_release": 1,
"application_id": "<string>",
"adoption_ids": [
"<string>"
],
"approved_by_person_id": "<string>",
"approved_by_name": "<string>",
"completed_where_kind": "location",
"completed_where_id": "<string>",
"completed_where_label": "<string>",
"payment_method": "<string>",
"payment_instructions": "<string>",
"voided_at": "2023-11-07T05:31:56Z",
"voided_by_person_id": "<string>",
"void_reason": "<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)"
}Signed contracts
List signed contracts
Every signed contract, newest first, without its text. For one record, send entity_type and entity_id together; for an adoption this also finds a contract signed on an application that names the adoption among others. Needs read on Animals.
GET
/
api
/
animals
/
contracts
List signed contracts
curl --request GET \
--url https://{organization}.rescueconsole.com/api/animals/contracts \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/animals/contracts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/contracts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"id": "<string>",
"contract_name": "<string>",
"contract_version": "<string>",
"signer_name": "<string>",
"signed_at": "2023-11-07T05:31:56Z",
"entity_type": "adoption",
"entity_id": "<string>",
"is_voided": true,
"template_id": "<string>",
"contract_body": "<string>",
"contract_body_blocks": [
{
"type": "p",
"runs": [
{
"text": "<string>",
"bold": true,
"italic": true,
"underline": true,
"strike": true,
"href": "<string>"
}
],
"items": [
[
{
"text": "<string>",
"bold": true,
"italic": true,
"underline": true,
"strike": true,
"href": "<string>"
}
]
],
"level": 1,
"rows": [
[
[
{
"text": "<string>",
"bold": true,
"italic": true,
"underline": true,
"strike": true,
"href": "<string>"
}
]
]
],
"src": "<string>",
"alt": "<string>"
}
],
"signer_person_id": "<string>",
"signer_email": "<string>",
"consent_acknowledged": true,
"recorded_by_person_id": "<string>",
"media_release": 1,
"application_id": "<string>",
"adoption_ids": [
"<string>"
],
"approved_by_person_id": "<string>",
"approved_by_name": "<string>",
"completed_where_kind": "location",
"completed_where_id": "<string>",
"completed_where_label": "<string>",
"payment_method": "<string>",
"payment_instructions": "<string>",
"voided_at": "2023-11-07T05:31:56Z",
"voided_by_person_id": "<string>",
"void_reason": "<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_.
Query Parameters
What the record is. Send with entity_id.
Available options:
adoption, foster_assignment, animal_intake The record's ID. Send with entity_type.
The contracts one person signed.
Response
The signed contracts.
Show child attributes
Show child attributes