Get combined flock data

GET

/api/v1/flocks/{identifier}

• Production
• Development

Returns combined central flock record and flock_settings in a single response.

Authorizations

• ApiKeyAuth
• SessionCookie

Parameters

Path Parameters

identifier

required

string

Example

myflock

Flock identifier (bucket name)

Responses

200

Combined flock data

object

data

object

central

Central flock record from MongoDB

object

_id

string

data

object

bucket

string

name

string

products

Array<string>

packs

Array<string>

settings

Flock settings document

object

_id

string

flock_id

string

branding

object

brand_colour

string

logo_url

string

401

Unauthorized - missing or invalid credentials

object

error

object

code

Error code

string

Allowed values: BAD_REQUEST UNAUTHORIZED NOT_FOUND CONFLICT INTERNAL_ERROR

message

Human-readable error message

string

404

Resource not found

object

error

object

code

Error code

string

Allowed values: BAD_REQUEST UNAUTHORIZED NOT_FOUND CONFLICT INTERNAL_ERROR

message

Human-readable error message

string