Get Animal

Current animals HTTP operation. External credential scopes: read:animals; include_saved_births additionally requires read:records. 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.

get/v1/farm/{farm_id}/animals/{animal_id}

Request

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

Path parameters

farm_idstring uuid required

animal_idstring uuid required

Query parameters

include_saved_birthsboolean

Also return saved_births for this animal as dam or offspring. Send the exact lowercase string true or false; omission defaults to false. Enabling expansion additionally requires the read:records scope (403 insufficient_scope otherwise) and is never truthy-coerced.

birth_skipinteger

Offset into saved_births; default 0.

birth_takeinteger

Page size for saved_births; default 50, maximum 200.

Response

Success

idstring required

created_atstring date-time required

updated_atstring date-time required

is_activeboolean required

farm_idstring required

metadataunknown required

inventory_status'CURRENT' | 'UNKNOWN' | 'SOLD' | 'DECEASED' | 'NOT_MANAGED' required

Changes

No recorded changes to this operation across all 1 revision of this API.