curl --request GET \
--url https://{organization}.rescueconsole.com/api/organizations/organizations/facets \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/organizations/organizations/facets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/organizations/organizations/facets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"total": 123,
"facets": {
"kind": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"relationship": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"is_active": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
]
}
}{
"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)"
}Count organizations
How many organizations match the same filters as the list, and how many there are of each kind, each relationship, and in use or archived. Each group is counted as if its own filter were not set, so you can see what picking another value would give. Every kind and relationship is listed, at 0 when nothing has it; organizations with no relationship are not counted in that group. The in-use and archived counts ignore include_inactive. Needs read on Organizations.
curl --request GET \
--url https://{organization}.rescueconsole.com/api/organizations/organizations/facets \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/organizations/organizations/facets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/organizations/organizations/facets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"total": 123,
"facets": {
"kind": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"relationship": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"is_active": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
]
}
}{
"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
Organizations of this kind. What the organization is.
veterinary_practice, rescue, shelter, supplier, employer, government, other Organizations with this relationship to you. What the organization is to you. Separate from its kind: a past client can be a veterinary practice.
prospect, active_client, past_client, partner, supplier, competitor The name contains this.
true to include archived organizations, which are left out otherwise.