> ## 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. # Get the housing board > Every place in your buildings, with the animals in care in each: campuses, buildings, rooms and cages. It is one flat list, by each unit's place among its neighbours and then by name; build the tree from parent_id. Foster homes and virtual placements are not on it. Retired units are left out unless you ask for them. At most 2,000 units come back; truncated says whether there were more. Needs **read** on Animals. ## OpenAPI ````yaml /api-reference/openapi.json get /api/animals/locations/board 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/locations/board: get: tags: - Locations and housing summary: Get the housing board description: >- Every place in your buildings, with the animals in care in each: campuses, buildings, rooms and cages. It is one flat list, by each unit's place among its neighbours and then by name; build the tree from parent_id. Foster homes and virtual placements are not on it. Retired units are left out unless you ask for them. At most 2,000 units come back; truncated says whether there were more. Needs **read** on Animals. operationId: getHousingBoard parameters: - name: root in: query description: >- One unit and everything inside it, at any depth, instead of everything. schema: type: string - name: include_retired in: query description: true to include retired units. schema: type: boolean default: false responses: '200': description: The board. content: application/json: schema: type: object required: - results - truncated - unplaced properties: results: type: array items: $ref: '#/components/schemas/LocationBoardUnit' truncated: type: boolean description: Whether there were more than 2,000 units. unplaced: type: array items: $ref: '#/components/schemas/LocationBoardAnimal' description: >- Up to 200 animals in care that are in no place, or in a retired one. Always empty when you give root. '401': $ref: '#/components/responses/Problem' '403': $ref: '#/components/responses/Problem' '404': $ref: '#/components/responses/Problem' components: schemas: LocationBoardUnit: allOf: - $ref: '#/components/schemas/LocationUnit' - type: object required: - animals properties: animals: type: array items: $ref: '#/components/schemas/LocationBoardAnimal' description: The animals in care placed in this unit, by name. LocationBoardAnimal: type: object required: - id - species - status properties: id: type: string name: type: - string - 'null' species: type: string description: The species key, such as cat. status: type: string description: One of your own status keys. photo_file_id: type: - string - 'null' description: The ID of its photo, if it has one. LocationUnit: type: object required: - id - unit_type - name - capacity - status - combined_with - effective_capacity - effective_occupants properties: id: type: string parent_id: type: - string - 'null' description: The unit this one is inside, or null for one at the top. unit_type: type: string enum: - campus - building - room - cage - foster_home - virtual description: A foster home and a virtual placement are not space in a building. name: type: string capacity: type: integer description: How many animals it holds. 0 means it is not counted. is_virtual: type: boolean description: >- True for a foster home or a virtual placement. It follows from the type. foster_person_id: type: - string - 'null' description: The person, for a foster home unit. org_location_id: type: - string - 'null' description: >- Set when this unit stands for one of your locations in Settings. Its name, type, parent and status are changed there, under Locations, and not here. combined_with: type: array items: type: string description: >- The cages joined to this one by tunnels. Every cage in a space lists every other one. status: type: string enum: - active - inactive - out_of_service description: >- active is in service. out_of_service is not in use for now. inactive is retired. sort_order: type: integer description: Its place among the units inside the same parent. custom_fields: type: object additionalProperties: true description: Your own location fields, by field key. created_at: type: string format: date-time updated_at: type: string format: date-time effective_capacity: type: integer description: >- The capacity of the whole space: this unit and every cage joined to it. effective_occupants: type: integer description: >- Animals in care in the whole space: this unit and every cage joined to it. Only animals placed in the unit itself count, not animals in units inside it. 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_. ````