> ## Documentation Index > Fetch the complete documentation index at: https://docs.rescueconsole.com/llms.txt > Use this file to discover all available pages before exploring further. # Count animals by filter > How many animals each filter value would find, for the same filters the list takes. Each group is counted with every other filter applied but not its own, so choosing one status does not turn the other statuses to 0. Tag counts can add up to more than the total, because an animal can carry several tags. Needs **read** on Animals. ## OpenAPI ````yaml /api-reference/openapi.json get /api/animals/animals/facets openapi: 3.1.0 info: title: RescueConsole API version: '2026-09-19' description: >- Your own organization's records, from your own software. There is no sandbox: every request goes to your live organization. servers: - url: https://{organization}.rescueconsole.com description: Your own organization's address, the one you sign in at. variables: organization: default: your-rescue description: >- The first part of the address you sign in at. A key only works at the address of the organization it was made in. security: - apiKey: [] tags: - name: Animals description: The animals in your care, and the ones you have placed. - name: Animal notes description: Notes written on an animal's record. - name: Animal weights description: An animal's weight readings, one per weighing. - name: Animal medical records description: >- Vaccines, treatments, procedures, tests, exams and other medical records on one animal. - name: Animal placements description: The people an animal came from or has been placed with, over time. - name: Animal nutrition description: 'What an animal eats: its feeding list and its diet.' - name: Animal relationships description: Siblings, parents, offspring and bonded pairs. - name: Animal tags description: Your own short labels on an animal. - name: Breeds description: The breed or kind lists your intake form offers for each species. - name: Litters description: Litters, and the animals born into them. - name: Locations and housing description: >- The places animals are housed at each of your locations: campuses, buildings, rooms and cages, the tunnels that join cages into one space, and who is in each. - name: Foster homes description: >- The people who foster for you, what each home can take, and the animals offered to and placed with them. - name: Intakes description: >- How each animal arrived: the route in, who brought it, why it was given up and the state it came in. - name: Medical due description: >- Medical work that is outstanding across all your animals, and one medical record added to many animals at once. - name: Transports description: >- Transport runs: a chain of drives, each leg with its own driver, that moves animals from one place to another. - name: Animal calendar description: >- The dated things in animal care on one calendar: medical work due, adoptions, foster placements starting and ending, arrivals, and meet and greets. - name: Animal reports description: >- The operations report: intakes, outcomes, live release rate and the animals in your care, each figure with its own definition. - name: Adoption applications description: >- Applications to adopt or foster, from first draft to a decision, and the adoption contract signed on an approved one. - name: Adoptions description: >- Animals that went home, what each adopter owes and has paid, and closing or reversing the adoption. - name: Signed contracts description: >- Contracts signed on an adoption, a foster placement or an intake, each kept exactly as it read when it was signed. - name: Contract templates description: >- The contracts your organization has people sign, with the merge fields that fill them in. - name: Reconciliations description: >- A payment processor's settlement lines, matched against the adoption payments you recorded. - name: Animal custom fields description: >- The extra fields your organization adds to animals, housing units and adoption applications. - name: Age groups description: >- What counts as a baby, an adult or a senior, per species, which fee rules and discounts read. - name: Animal statuses description: >- Your organization's status vocabulary for animal records, and what kind of status each one is. - name: Application stages description: >- The steps an adoption or foster application moves through before it is decided, in your organization's words. - name: Behaviour attributes description: >- The catalogue of behavioural traits, and where a trait with each name may be shown beyond the record. - name: Cage card templates description: >- The layouts your organization prints for the kennel door: paper, fields, photo and QR code. - name: Adoption fee schedules description: >- The rules that suggest an animal's adoption fee, and the discounts laid over them. - name: Medical catalogue description: >- The diagnoses, tests, vaccines, treatments, procedures, conditions and medications your medical records pick from. - name: People description: >- The people your organization deals with: adopters, donors, volunteers, fosters and everybody else. - name: Person notes description: Notes written on a person's record. - name: Person contacts description: >- A person's phone numbers and email addresses, one of each kind marked primary. - name: Person addresses description: A person's addresses, one of them primary. - name: Person tags description: Free-text labels on a person, added and removed one at a time. - name: People duplicates description: People who look like the same person entered twice, and merging them. - name: People custom fields description: The fields a person's record carries beyond the standard ones. - name: Organizations description: >- The outside organizations your rescue deals with: veterinary practices, partner rescues, shelters, suppliers, employers and agencies. - name: Organization locations description: An organization's places, one of them the main one. - name: Affiliations description: >- Who works at, volunteers for or otherwise belongs to an organization, now or in the past. - name: Forms description: >- The forms your organization publishes, such as an adoption application or a volunteer sign-up, and the questions on them. - name: Submissions description: >- What people sent through your forms, and what your team does with each one. - name: Tasks description: >- To-dos, on a record or for the whole organization, narrowed to the records your key may read. - name: Calendar description: >- The dated work across your organization in one list, narrowed to the areas your key may read. - name: Activity description: >- What was created, changed and deleted in your organization, narrowed to the areas your key may read. - name: Shift schedules description: >- Schedules: the occasions shifts are grouped under, such as an adoption day or Saturday kennel cover. - name: Shift windows description: >- Shifts: a stretch of time at a place, with the volunteer roles it needs and how many of each (the address calls a shift a window). - name: Shift bookings description: >- Sign-ups: a person taking a role on a shift, giving it up, and the hours they worked. - name: Volunteers description: >- The people who volunteer: where each stands, what they have done, and where they would rather work. - name: Volunteer roles description: >- The jobs a volunteer can sign up for, such as Dog walker or Adoption counselor. - name: Volunteer qualifications description: 'Approvals: who may take which role, and at which location.' - name: Shift policies description: The rules you set for sign-ups and cancellations. - name: Shift calendar description: Schedules and shifts as calendar items for a date range. - name: Shift custom fields description: Your own fields on schedules, shifts and sign-ups. - name: Events description: >- The occasions your rescue hosts: adoption days, fundraisers, clinics and the rest. - name: Events calendar description: Your events between two days, as calendar entries. - name: Campaigns description: >- Appeals you raise money for, each with its goal and what it has raised so far. - name: Donations description: 'Gifts of money: how much, from whom, and what they were given to.' - name: Donors description: The people who have given, with what each has given in all. - name: Wish list description: The things your rescue needs, and the deliveries that met them. - name: Fundraising custom fields description: Your organization's own fields on donations and campaigns. - name: Message templates description: >- Saved wording your organization sends again and again, with merge fields filled from your records. - name: Sending description: >- Everything here sends real email from your organization, and none of it can be unsent. - name: Message log description: >- The email your organization has sent or tried to send, and what became of each message. - name: Conversations description: >- The email conversations in your organization's inboxes, and the records each one is about. - name: Inboxes description: >- The addresses your organization receives email at, and who may read each one. - name: Contact preferences description: >- Whether a person has asked not to be emailed, altogether or about one kind of message. - name: Suppressions description: >- Addresses no email goes to, because mail to them bounced or their owner asked not to be written to. - name: Sender and deliverability description: Who your organization's email goes out as, and how much of it arrives. - name: Registry flags description: >- Safety flags your organization files about a person or an animal, which other organizations using RescueConsole can see once the flag is vetted and shared. - name: Registry reviews description: >- Another organization's vote on a flag it did not file, which decides whether the flag becomes active or disputed. - name: Registry search description: >- The lookup by microchip number that anybody may make, with or without a key. paths: /api/animals/animals/facets: get: tags: - Animals summary: Count animals by filter description: >- How many animals each filter value would find, for the same filters the list takes. Each group is counted with every other filter applied but not its own, so choosing one status does not turn the other statuses to 0. Tag counts can add up to more than the total, because an animal can carry several tags. Needs **read** on Animals. operationId: getAnimalFacets parameters: - name: status in: query description: One or more of your own status keys, comma separated. schema: type: string example: available_for_adoption,adoption_pending - name: care_state in: query description: 'Every status of one kind: in your care, placed, or out of your care.' schema: type: string enum: - in_care - placed - out_of_care - name: species in: query description: >- One or more species, comma separated. A common word for a species (Dogs, Kitten) finds the same animals as its key. schema: type: string example: dog,cat - name: location_unit_id in: query description: Animals housed at one location or unit. schema: type: string - name: tag in: query description: Animals carrying this tag, exactly as written. schema: type: string - name: age_band in: query description: >- One of your age groups (baby, young, adult and senior unless you have changed them) or `unknown` for animals with no date of birth. When exactly one species is asked for, that species' own age groups are used. schema: type: string - name: search in: query description: Text found in the name, breed, microchip number or Pet ID. schema: type: string - name: outcome_person_id in: query description: Animals whose outcome names this person, such as their adopter. schema: type: string - name: name in: query description: Animals whose internal name contains this text. schema: type: string - name: pet_id in: query description: Animals whose Pet ID contains this text. schema: type: string - name: breed in: query description: Animals whose breed contains this text. schema: type: string - name: sex in: query description: Sex, one or more, comma separated. schema: type: string example: male,female - name: altered in: query description: >- Spayed or neutered: yes, no or unknown, one or more, comma separated. schema: type: string example: yes,no - name: size in: query description: >- Size (small, medium, large, extra_large), one or more, comma separated. schema: type: string example: small,medium - name: intake_source in: query description: >- Intake source (stray, transfer, owner_surrender, field, born_in_care, adoption_return, seized, other), one or more, comma separated. schema: type: string example: stray,transfer - name: health_status in: query description: Animals whose health status contains this text. schema: type: string - name: microchip_number in: query description: Animals whose microchip number contains this text. schema: type: string - name: description in: query description: Animals whose description contains this text. schema: type: string - name: is_public in: query description: Whether the animal itself is marked public. schema: type: string enum: - 'yes' - 'no' - name: intake_date_from in: query description: Intake date on or after this date. schema: type: string format: date - name: intake_date_to in: query description: Intake date on or before this date. schema: type: string format: date - name: outcome_date_from in: query description: Outcome date on or after this date. schema: type: string format: date - name: outcome_date_to in: query description: Outcome date on or before this date. schema: type: string format: date - name: dob_estimate_from in: query description: Date of birth on or after this date. schema: type: string format: date - name: dob_estimate_to in: query description: Date of birth on or before this date. schema: type: string format: date - name: created_at_from in: query description: >- Created on or after this date. This one holds a time as well as a date, so a `_to` date stops before that day begins: send the next day to include it. schema: type: string format: date - name: created_at_to in: query description: >- Created on or before this date. This one holds a time as well as a date, so a `_to` date stops before that day begins: send the next day to include it. schema: type: string format: date - name: updated_at_from in: query description: >- Last changed on or after this date. This one holds a time as well as a date, so a `_to` date stops before that day begins: send the next day to include it. schema: type: string format: date - name: updated_at_to in: query description: >- Last changed on or before this date. This one holds a time as well as a date, so a `_to` date stops before that day begins: send the next day to include it. schema: type: string format: date - name: adoption_fee_cents_min in: query description: Adoption fee of at least this many cents. schema: type: integer - name: adoption_fee_cents_max in: query description: Adoption fee of at most this many cents. schema: type: integer - name: include_deleted in: query description: Send `1` to include deleted animals. schema: type: string enum: - '1' responses: '200': description: The counts. content: application/json: schema: $ref: '#/components/schemas/AnimalFacets' '400': $ref: '#/components/responses/Problem' '401': $ref: '#/components/responses/Problem' '403': $ref: '#/components/responses/Problem' components: schemas: AnimalFacets: type: object properties: total: type: integer description: How many animals match every filter. facets: type: object properties: status: type: array items: $ref: '#/components/schemas/AnimalFacetCount' description: Every one of your statuses, in your order, those at 0 included. care_state: type: array items: $ref: '#/components/schemas/AnimalFacetCount' description: in_care, placed and out_of_care, those at 0 included. species: type: array items: $ref: '#/components/schemas/AnimalFacetCount' description: Each species with an animal, most first. location_unit_id: type: array items: $ref: '#/components/schemas/AnimalFacetCount' description: >- Each location with an animal, most first. The label is the location's name. tag: type: array items: $ref: '#/components/schemas/AnimalFacetCount' description: Each tag in use, most first. age_band: type: array items: $ref: '#/components/schemas/AnimalFacetCount' description: >- Your age groups in order, each label with its range, and unknown last. status_labels: type: object additionalProperties: type: string description: Each of your status keys with its label. AnimalFacetCount: type: object properties: value: type: string description: What to send as the filter. label: type: string count: type: integer responses: Problem: description: What is wrong, in one sentence you can show to a person. content: application/json: schema: type: object required: - error properties: error: type: string example: error: house_trained must be 1, 0 or null (not assessed) securitySchemes: apiKey: type: http scheme: bearer description: An API key from Settings, API keys. It starts with rc_live_. ````