birth-events

Get a birth event

Retrieve a saved birth and its accessible evidence from the current farm. External credential scopes: read:records. Minimum farm role: READER.

get/v1/farm/{farm_id}/birth-events/{event_id}

Request

  • Base URL: https://api.ranch.bot
  • URL: https://api.ranch.bot/v1/farm/{farm_id}/birth-events/{event_id}
  • Auth: HTTP bearer

Path parameters

farm_idstring uuid required
event_idstring uuid required

Response

Success

idstring uuid required
farm_idstring uuid required
request_idstring uuid required
confirmation_hashstring required
created_by_user_idstring uuid required
dam_idstring uuid required
birth_datestring date-time required
time_precisionstring nullable required
record_idstring uuid required
source_sms_idstring uuid nullable required
source_message_idstring uuid nullable required
agent_action_idstring uuid nullable required
created_atstring date-time required
media_file_idsstring[]

Unique, access-filtered file UUIDs referenced by the accepted birth evidence and the primary record.

Changes

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