Get Records

Current records HTTP operation. External credential scopes: read:records. 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. An animal_id or group_id target and/or applied_from/applied_before time bound returns filtered history with skip 0 and take 50 by default, up to 200 records per page. The response always lists same-farm animal and group attachment ids in records[].animals and records[].groups; only the current group names in match_context.current_groups and scope.authorized_groups require include_group_context. Scoped credentials: animal_id also needs read:animals, group_id also needs read:groups, and include_group_context needs both.

get/v1/farm/{farm_id}/records

Request

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

Path parameters

farm_idstring uuid required

Query parameters

skipinteger

takeinteger

type'FEED' | 'GENETIC' | 'HEALTH' | 'MOVEMENT' | 'OTHER'

Filter by record type.

animal_idstring uuid

Direct saved records for one animal UUID, regardless of inventory status.

group_idstring uuid

Direct saved records for one same-farm group UUID (archived groups allowed).

include_group_contextboolean

With animal_id, also include records attached to the animal's current active same-farm groups. Requires animal_id.

applied_fromstring date-time

Inclusive RFC3339 timestamp with an explicit timezone offset.

applied_beforestring date-time

Exclusive RFC3339 timestamp with an explicit timezone offset.

Response

Success

totalnumber required

Changes

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