Skip to content
FloralityDocs
ChangelogGet an API key

Getting started

  • Quickstart
  • Authentication
  • Scopes
  • Privacy buckets
  • Rate limits
  • Errors
  • Versioning
  • Terminology
  • Webhooks PRO

Resources

  • Members
  • Groups
  • Entries
  • Front
  • Appearance
  • Custom fields
  • Trash
  • Search
  • Member statuses
  • Systems
  • Messaging
  • Privacy buckets
  • Terminology
  • Friends
  • Subscriptions
  • Billing
  • Import
  • Social
  • Guestbook & poll
  • Group layout
  • Activity
Docs/Resources/get privacy buckets defaults kind
Florality

Organise your system. One front at a time.

Get started

Product

  • Features
  • Pricing
  • Docs
  • Changelog
  • Security

Company

  • About
  • Our team
  • Blog
  • Contact

Resources

  • FAQ
  • Trust and Safety
  • Public REST API

Legal

  • Privacy Policy
  • Terms of Service
  • Refunds and cancellation

© 2026 Florality. All rights reserved.

Florality
Privacy bucketsGet default buckets

Get default buckets

Returns default buckets for the authorised account.

GET
/api/v1/privacy-buckets/defaults/{kind}
privacyBuckets: read1,000 requests/minute/key · all plans

Active API keys: Free 1, Pro 5, Pro+ 5. The request rate is the same on every plan.

Parameters

Path parameters

NameTypeRequiredDescription
kindstringRequiredIdentifier of the kind.

Response schema

200

Successful response.

NameTypeRequiredDescription
kindstringRequiredKind. Allowed values: "new_member", "new_group", "new_directory", "new_custom_field", "new_profile_section", "new_friend".
bucketIdsarray<string>RequiredBucket Ids.

Errors

400 · JSON error

Invalid default kind.

401 · JSON error

Missing or invalid API key. Use Authorization: Bearer <token>.

403 · JSON error

Requires privacyBuckets: read; ownership or feature restrictions may also deny access.

404 · JSON error

Request failed (NOT_FOUND).

409 · JSON error

Request failed (CONFLICT).

429 · JSON error

API rate limit exceeded (1000 requests per minute). Retry shortly.

← Previous endpointBulk adjust member bucket membershipNext endpoint →Set default buckets

Request example

Set FLORALITY_KEY in your environment. These examples use demo identifiers.

Shell
curl --request GET 'https://floralitys.com/api/v1/privacy-buckets/defaults/11111111-1111-4111-8111-111111111111' \
  --header "Authorization: Bearer $FLORALITY_KEY"

Responses

Successful response.

JSON
{
  "kind": "new_member",
  "bucketIds": [
    "11111111-1111-4111-8111-111111111111"
  ]
}

Example values are illustrative demo data.