Birds

Search Birds in a Nest

Returns the Birds in a Nest. Results can be filtered by trigger type and status.

get/nests/{nestId}/birds

Request

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

Path parameters

nestIdstring required

The ID of the Nest that contains the Birds.

Query parameters

TriggerType'manual' | 'event' | 'scheduled'

Filters Birds by how they are triggered: manual, event, or scheduled. Only manual Birds can be triggered through the POST Bird endpoint in this API.

Status'active' | 'unpublished' | 'suspended'

Filters Birds by status. Unpublished Birds are drafts. Active Birds are enabled. Suspended Birds were active Birds that were temporarily paused.

Response

A list of Birds in the Nest.

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.