Get flock settings

GET

/api/v1/flocks/{identifier}/settings

• Production
• Development

Returns only the flock_settings document.

Authorizations

• ApiKeyAuth
• SessionCookie

Parameters

Path Parameters

identifier

required

string

Example

myflock

Flock identifier (bucket name)

Responses

200

Flock settings

object

data

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