animals

Get Animals

Current animals HTTP operation. External credential scopes: read:animals. Minimum farm role: READER. Pagination accepts integer skip and take; set both explicitly. An omitted value passes through to the data query. Collection property names differ by resource; use the response schema. 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. With a nonblank query, searches active saved identifiers and the canonical current profile name (metadata.name). Exact is case-sensitive full-value equality; partial is a literal case-insensitive substring over profile names, NAME and MANAGEMENT_TAG identifiers. Defaults to inventory_status=ALL and skip 0 / take 50 (max 200) while searching.

get/v1/farm/{farm_id}/animals

Request

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

Path parameters

farm_idstring uuid required

Query parameters

skipinteger
takeinteger
inventory_status'CURRENT' | 'UNKNOWN' | 'SOLD' | 'DECEASED' | 'NOT_MANAGED' | 'ALL'
querystring

Saved identifier value or current profile name to find. Blank is rejected.

match_mode'exact' | 'partial'

exact (default) full-value equality, or partial literal case-insensitive substring discovery.

identifier_type'BRAND' | 'EID' | 'MANAGEMENT_TAG' | 'NAME' | 'TATTOO'

Restrict matching to one saved identifier type; binding on an exact query.

Response

Success

totalnumber required
outcome'not_found' | 'unique' | 'ambiguous' | 'candidates'

Changes

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