> ## 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 calendar > Everything dated between two days, from every area your key may read, in one list. There is no permission of its own for the calendar: tasks with a due date are always included, narrowed exactly as List tasks is; medical items due, adoptions, animals into and out of foster, arrivals and meet and greets need **read** on Animals; shift schedules and shifts need **read** on Shifts. Items come sorted by day, all-day items before timed ones on the same day, then by time, then by title. There is no paging: the range is the page, and it may be at most 366 days. Each kind returns at most 1,000 items in one range (tasks, 2,000). If an area cannot be loaded, the rest of the calendar is still returned and `unavailable` names what is missing, so an empty day is never mistaken for a quiet one. ## OpenAPI ````yaml /api-reference/openapi.json get /api/calendar 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/calendar: get: tags: - Calendar summary: Get the calendar description: >- Everything dated between two days, from every area your key may read, in one list. There is no permission of its own for the calendar: tasks with a due date are always included, narrowed exactly as List tasks is; medical items due, adoptions, animals into and out of foster, arrivals and meet and greets need **read** on Animals; shift schedules and shifts need **read** on Shifts. Items come sorted by day, all-day items before timed ones on the same day, then by time, then by title. There is no paging: the range is the page, and it may be at most 366 days. Each kind returns at most 1,000 items in one range (tasks, 2,000). If an area cannot be loaded, the rest of the calendar is still returned and `unavailable` names what is missing, so an empty day is never mistaken for a quiet one. operationId: getCalendar parameters: - name: from in: query required: true description: The first day, YYYY-MM-DD. schema: type: string format: date - name: to in: query required: true description: >- The last day, YYYY-MM-DD, included. Not before from, and at most 366 days after it. schema: type: string format: date - name: sources in: query description: >- Only these kinds of item, comma-separated. Leave it out for every kind your key may read, which is also how meet and greets are included. A kind that does not exist is refused. style: form explode: false schema: type: array items: type: string enum: - task - volunteer_event - volunteer_session - medical_due - adoption - foster_start - foster_end - intake - name: tone in: query description: Only items in these states, comma-separated. style: form explode: false schema: type: array items: $ref: '#/components/schemas/CalendarTone' responses: '200': description: The items in the range. content: application/json: schema: type: object required: - results - unavailable properties: results: type: array items: $ref: '#/components/schemas/CalendarItem' unavailable: type: array description: >- The areas whose items could not be loaded this time, such as animals or shifts. Usually empty. items: type: string '400': $ref: '#/components/responses/Problem' '401': $ref: '#/components/responses/Problem' components: schemas: CalendarTone: type: string description: >- The item's state. overdue: a task or medical item whose day has passed and that is not done. due: a task or medical item due today or later, or a meet and greet whose day has passed without being marked done. scheduled: a shift, a shift schedule or a meet and greet still to come. done: done, performed or completed, and a dated fact such as an adoption, an arrival or a foster placement. cancelled: a reversed adoption, a declined foster placement, a cancelled shift or schedule. enum: - overdue - due - scheduled - done - cancelled CalendarItem: type: object description: >- One dated thing. An all-day item carries a date and never a time, so it lands on the right day wherever the reader is. required: - id - source - module - title - starts_at - ends_at - all_day - entity_type - entity_id - tone - detail properties: id: type: string description: 'Unique across the calendar: the kind, a colon, then a record ID.' source: type: string description: >- The kind of item. task: a task with a due date, on that day (a task that stands for a medical item or a meet and greet is left out, because that item is here instead). medical_due: medical work due on an animal, timed when it was given a start time. adoption: an animal adopted, on the day. foster_start and foster_end: an animal into foster and out of it (the end only once the placement has ended). intake: an animal's arrival. meet: a meet and greet on an adoption application, timed when it was given a time. volunteer_event: a shift schedule (drafts are left out). volunteer_session: one shift, always timed. enum: - task - volunteer_event - volunteer_session - medical_due - adoption - foster_start - foster_end - intake - meet module: type: - string - 'null' description: >- The area the item comes from, such as animals or shifts. Can be null for a task. title: type: string description: 'Such as "Biscuit: Rabies vaccine" or "Biscuit adopted".' starts_at: type: string description: YYYY-MM-DD when all_day is true, a date and time otherwise. ends_at: type: - string - 'null' description: In the same shape as starts_at, when the item has an end. all_day: type: boolean entity_type: type: - string - 'null' description: >- The kind of record the item is about, such as animal, adoption, adoption_application, volunteer_event or volunteer_session; for a task, the kind of record the task is on. entity_id: type: - string - 'null' description: >- The record ID of that record. For foster_start and foster_end it is the foster placement's record ID, not the animal's. tone: $ref: '#/components/schemas/CalendarTone' detail: type: - string - 'null' description: >- A second line, such as the animal, the adopter, the foster home or the assignee; for a shift, how many of its places are filled, and where. assignees: type: array description: >- Who is on it: a task's assignee (an empty list when it has none), the people booked on a shift (at most eight names), the people meeting the applicant at a meet and greet. Absent on kinds of item nobody is assigned to. items: type: object required: - person_id - name properties: person_id: type: string name: type: string medical_record_id: type: - string - 'null' description: On a medical_due item, the medical record it is. 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_. ````