Plan a transport run
curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/transports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Contoso to Northfield, October",
"scheduled_date": "2026-10-03",
"origin": "Contoso Animal Rescue, Main St",
"destination": "Northfield Humane Society"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Contoso to Northfield, October',
scheduled_date: '2026-10-03',
origin: 'Contoso Animal Rescue, Main St',
destination: 'Northfield Humane Society'
})
};
fetch('https://{organization}.rescueconsole.com/api/animals/transports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/transports"
payload = {
"name": "Contoso to Northfield, October",
"scheduled_date": "2026-10-03",
"origin": "Contoso Animal Rescue, Main St",
"destination": "Northfield Humane Society"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"scheduled_date": "2023-12-25",
"origin": "<string>",
"destination": "<string>",
"status": "planning",
"legs": [
{
"id": "<string>",
"sequence": 123,
"from_place": "<string>",
"to_place": "<string>",
"driver_person_id": "<string>",
"depart_at": "<string>",
"arrive_at": "<string>",
"driver_name": "<string>",
"notes": "<string>"
}
],
"animals": [
{
"id": "<string>",
"name": "<string>",
"species": "<string>",
"status": "<string>",
"notes": "<string>"
}
],
"problems": [
{
"kind": "no_legs",
"sequence": 123,
"message": "<string>"
}
],
"notes": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"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)"
}Transports
Plan a transport run
Creates a run in planning, with no legs and no animals. Add the legs with the legs call and the animals with the animals call. Answers 200 with the whole run, not 201. Needs write on Animals.
POST
/
api
/
animals
/
transports
Plan a transport run
curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/transports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Contoso to Northfield, October",
"scheduled_date": "2026-10-03",
"origin": "Contoso Animal Rescue, Main St",
"destination": "Northfield Humane Society"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Contoso to Northfield, October',
scheduled_date: '2026-10-03',
origin: 'Contoso Animal Rescue, Main St',
destination: 'Northfield Humane Society'
})
};
fetch('https://{organization}.rescueconsole.com/api/animals/transports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/transports"
payload = {
"name": "Contoso to Northfield, October",
"scheduled_date": "2026-10-03",
"origin": "Contoso Animal Rescue, Main St",
"destination": "Northfield Humane Society"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"scheduled_date": "2023-12-25",
"origin": "<string>",
"destination": "<string>",
"status": "planning",
"legs": [
{
"id": "<string>",
"sequence": 123,
"from_place": "<string>",
"to_place": "<string>",
"driver_person_id": "<string>",
"depart_at": "<string>",
"arrive_at": "<string>",
"driver_name": "<string>",
"notes": "<string>"
}
],
"animals": [
{
"id": "<string>",
"name": "<string>",
"species": "<string>",
"status": "<string>",
"notes": "<string>"
}
],
"problems": [
{
"kind": "no_legs",
"sequence": 123,
"message": "<string>"
}
],
"notes": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"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
Response
The run, as it was created.
Available options:
planning, confirmed, in_progress, completed, cancelled In order.
Show child attributes
Show child attributes
The animals on the run, by name.
Show child attributes
Show child attributes
Every reason the run cannot be confirmed yet. Empty when it is ready.
Show child attributes
Show child attributes