animals

Look up an animal by exact EID without writing

Read-only exact EID lookup across inventory statuses. Never creates or updates inventory. Missing matches return 404; multiple matching animals return 409. 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.

get/v1/farm/{farm_id}/animals/lookup-by-eid

Request

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

Path parameters

farm_idstring uuid required

Query parameters

eidstring required

Exact EID, including leading zeros.

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.