Skip to content
Not publicly available.This reference describes Ambula API v1 before launch. Endpoints, limits and fields can still change.

Runaways

Open reports of lost or escaped animals, with the owner, where the animal was last seen, and a photo.

List runaways

GET/v1/runaways

Requires the scope runaways:read.

Available from phase 2

Reports of lost or escaped animals (weglopers) that are still open.

Query parameters

created_afterISO 8601

Only records created after this time.

created_beforeISO 8601

Only records created before this time.

updated_afterISO 8601

Only records changed after this time. For a sync, pass your last sync time minus 60 seconds and deduplicate by id.

limitinteger

Page size, 1 to 100. Default 25.

cursorstring

The next_cursor of the previous page.

Get a runaway

GET/v1/runaways/{id}

Requires the scope runaways:read.

Available from phase 2

One report. The photo's url is a signed link valid for 15 minutes.

Create a runaway

POST/v1/runaways

Requires the scope runaways:write.

Available from phase 2

Report a lost or escaped animal.

Body

speciesstringrequired

Species.

namestring

The animal's name.

danger_levelstring

green, orange or red: how careful to be when approaching.

ownerobject

name and phone.

locationobject

Where it was last seen.

Update a runaway

PATCH/v1/runaways/{id}

Requires the scope runaways:write.

Available from phase 2

Change a report. Send If-Match with the ETag from your last read.

Body

locationobject

Where it was last seen.

Close a runaway

DELETE/v1/runaways/{id}

Requires the scope runaways:write.

Available from phase 2

Remove a report once the animal is found.

Set the photo

PUT/v1/runaways/{id}/photo

Requires the scope runaways:write.

Available from phase 2

Upload a photo as multipart/form-data (field photo, up to 10 MB). Location data and other metadata are removed. Replaces the previous photo.