Skip to main content
The RescueConsole API is the same API the application itself uses. An API key lets your own software reach your own organization’s records: nobody else’s, and nothing more than the person who made the key can reach.
There is no sandbox. Every request on these pages goes to your live organization. A GET reads real records; a POST, PATCH or DELETE changes them. Try writes against a test animal or person you have made for the purpose.

Your address

Requests go to your own organization’s address, the one you sign in at:
A key only works at the address of the organization it was made in. Presented anywhere else, it authenticates as nobody.

Make a key

In RescueConsole, open Settings → Advanced & security → API keys and create one. You choose:
  • A label, so you know later what it is for.
  • What it may do: for each area, read, write or admin. A key can never be given more than you can do yourself.
  • An expiry date, if you want one.
The key starts with rc_live_ and is shown once. Copy it then; it cannot be shown again. If it is lost or leaked, revoke it on the same page and make another.

Send it

Put the key in the Authorization header of every request:
One route needs no key: Get the status notice, GET /api/status/notice, which says only what the public status page says.

Try it on these pages

Every endpoint page has a playground that sends a real request and shows you the real answer.
1

Choose your address

Set organization to the first part of the address you sign in at. For https://contoso.rescueconsole.com, that is contoso.
2

Paste your key

Paste the whole key, rc_live_ and all, into the Authorization field. You do not type Bearer; the playground adds it.
3

Fill in what the request needs, and send it

The answer appears beneath: the status, and the body exactly as your own software would receive it.
The request goes from your browser straight to your organization’s address. Your key does not pass through this documentation site on the way. These pages accept an API key and nothing else. If you are signed in to RescueConsole in the same browser, that does not carry over: every request here is made with the key you paste, and can do only what that key may do. For a first try, make a key that may only read.

What a key can reach

Everything else is closed to a key on purpose: signing in, members and roles, your organization’s settings, billing, and API keys themselves. A key can never make another key.

Lists

Lists answer in results. A long list answers one page at a time:
Ask for the next page with offset, while has_more is true. Not every list pages, and not every one that pages gives a total: each endpoint’s page says what it answers, its default limit, and the most it will give at once.

When something is wrong

An error is a status code and one sentence you can show to a person:

Yes, no, and not assessed

Many answers about an animal have three states, not two: 1 (yes), 0 (no) and null (not assessed). Send null to clear an answer. Never send 0 to mean “we do not know”: it is read as a no, on applications and on listing sites.