Skip to content

Get a Bird

GET
/nests/{nestId}/birds/{birdId}

Returns a single Bird in a Nest by its ID.

Authorizations

Parameters

Path Parameters

nestId
required
string

The ID of the Nest that contains the Bird.

birdId
required
string

The ID of the Bird.

Responses

200

The requested Bird.

object
id
string
nestId
string
name
string
status
string
Allowed values: active unpublished suspended
triggerType
string
Allowed values: manual event scheduled
isPublished
boolean

404

Not Found

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties

500

Server Error