Skip to main content
GET
List organizations

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Query Parameters

limit
integer
default:50

How many to return. 50 unless you say, 200 at most.

Required range: 1 <= x <= 200
offset
integer
default:0

How many to skip, for the next page.

Required range: x >= 0
kind
enum<string>

Organizations of this kind. What the organization is.

Available options:
veterinary_practice,
rescue,
shelter,
supplier,
employer,
government,
other
relationship
enum<string>

Organizations with this relationship to you. What the organization is to you. Separate from its kind: a past client can be a veterinary practice.

Available options:
prospect,
active_client,
past_client,
partner,
supplier,
competitor

The name contains this.

include_inactive
boolean
default:false

true to include archived organizations, which are left out otherwise.

Response

One page of organizations.

results
object[]
required
limit
integer
required
offset
integer
required
has_more
boolean
required

Whether there is another page after this one.