---
title: "Get Animals Index"
method: GET
path: "/v1/farm/{farm_id}/animals/index"
tags: ["animals"]
---

# Get Animals Index

`GET /v1/farm/{farm_id}/animals/index`

## Request

- Base URL: `https://api.ranch.bot`
- URL: `https://api.ranch.bot/v1/farm/{farm_id}/animals/index`
- Auth: HTTP bearer

Current animals HTTP operation. External credential scopes: read:animals. Minimum farm role: READER. Production rate limit: 100 requests per 15-minute window per device account, 1000 per browser session, otherwise per client IP. RateLimit headers report the current window; respect Retry-After on 429. Defaults to CURRENT inventory. Use inventory_status=ALL to include all nondeleted historical profiles, or select UNKNOWN, SOLD, DECEASED, or NOT_MANAGED.

## Path parameters

- `farm_id` string, uuid, required

## Query parameters

- `inventory_status` 'CURRENT' | 'UNKNOWN' | 'SOLD' | 'DECEASED' | 'NOT_MANAGED' | 'ALL'

## Response `200`

Success

- object
  - `synced_at` string, required
  - `total` number, required
  - `animals` object[], required
    - `id` string, required
    - `metadata` unknown, required
    - `identifiers` object[], required
      - `type` 'BRAND' | 'EID' | 'MANAGEMENT_TAG' | 'NAME' | 'TATTOO', required
      - `value` string, required
      - `is_primary` boolean, required
    - `last_weights` object[], required
      - `value` number, required
      - `unit` string, nullable, required
      - `applied_at` string, date-time, required
    - `inventory_status` 'CURRENT' | 'UNKNOWN' | 'SOLD' | 'DECEASED' | 'NOT_MANAGED', required
    - `birth_facts` BirthFacts
      - `record` object, nullable, required
        - `record_id` string, required
        - `birth_event_id` string, required
        - `revision` number, required
        - `birth_date` string, required
        - `time_precision` string, nullable, required
        - `dam_id` string, required
        - `sire` BirthFactsSire, required
          - `status` 'unknown' | 'presumed' | 'confirmed', required
          - `animal_id` string, nullable, required
          - `provenance` string, nullable, required
          - `confidence` number, nullable, required
      - `derived` object, required
        - `birth_date` string, nullable, required
        - `time_precision` string, nullable, required
        - `dam_id` string, nullable, required
        - `sire` BirthFactsSire, required
          - `status` 'unknown' | 'presumed' | 'confirmed', required
          - `animal_id` string, nullable, required
          - `provenance` string, nullable, required
          - `confidence` number, nullable, required
      - `profile_birth_date` string, nullable, required
      - `effective_birth_date` string, nullable, required
      - `conflicts` object[], required
        - `independent_birth_date` string, required
        - `recorded_birth_date` string, required
        - `record_id` string, required

## Other responses

- `400`: Request validation failed.
- `401`: Missing/invalid authentication or insufficient farm role.
- `403`: Missing required scope or credential type is disallowed.
- `404`: Resource or active farm membership not found.
- `429`: Rate limit exceeded. Retry after the indicated delay.
- `500`: Unexpected server failure.

---

[API](https://skmtc.dev/ranch/apis/ranch-bot-http-api.md) · [All operations](https://skmtc.dev/ranch/apis/ranch-bot-http-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ranch/apis/ranch-bot-http-api/revisions/24109d33fa02?raw)