animals

Get Animals Index

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.

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

Path parameters

farm_idstring uuid required

Query parameters

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

Response

Success

synced_atstring required
totalnumber required

Changes

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