Birds

Get a Bird

Returns a single Bird in a Nest by its ID.

get/nests/{nestId}/birds/{birdId}

Request

  • Base URL: https://eu-1.blackbird.io/api-rest
  • URL: https://eu-1.blackbird.io/api-rest/nests/{nestId}/birds/{birdId}
  • Auth: API key in header Authorization

Path parameters

nestIdstring required

The ID of the Nest that contains the Bird.

birdIdstring required

The ID of the Bird.

Response

The requested Bird.

idstring
nestIdstring
namestring
status'active' | 'unpublished' | 'suspended'
triggerType'manual' | 'event' | 'scheduled'
isPublishedboolean

Changes

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