Get default buckets
Returns default buckets for the authorised account.
GET
/api/v1/privacy-buckets/defaults/{kind}privacyBuckets: read1,000 requests/minute/key · all plansActive API keys: Free 1, Pro 5, Pro+ 5. The request rate is the same on every plan.
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | Required | Identifier of the kind. |
Response schema
200
Successful response.
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | Required | Kind. Allowed values: "new_member", "new_group", "new_directory", "new_custom_field", "new_profile_section", "new_friend". |
bucketIds | array<string> | Required | Bucket Ids. |
Errors
400· JSON errorInvalid default kind.
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires privacyBuckets: read; ownership or feature restrictions may also deny access.
404· JSON errorRequest failed (NOT_FOUND).
409· JSON errorRequest failed (CONFLICT).
429· JSON errorAPI rate limit exceeded (1000 requests per minute). Retry shortly.
Request example
Set FLORALITY_KEY in your environment. These examples use demo identifiers.
curl --request GET 'https://floralitys.com/api/v1/privacy-buckets/defaults/11111111-1111-4111-8111-111111111111' \
--header "Authorization: Bearer $FLORALITY_KEY"Responses
Successful response.
{
"kind": "new_member",
"bucketIds": [
"11111111-1111-4111-8111-111111111111"
]
}Example values are illustrative demo data.
