Florality

Choose an access level

Level	Allows
`none`	No access to routes requiring this resource.
`read`	Routes requiring read access.
`read_write`	Both read and read_write routes.

New keys default every scope to none. The scope object has explicit resource keys; there is no wildcard scope. Start with the read scopes required by your requests and enable writes only when your integration needs them.

The operator-admin full-access setting bypasses per-resource scope checks. It does not replace ownership checks or the request rate limit.

Every scope

The exact scope names below come from the shared scope configuration. Expand a resource to see every route that requires it and the access level checked by that route.

Scope	Resource	Endpoints
`members`	Members	7 operations
`groups`	Groups & folders	8 operations
`directories`	Groups (legacy alias)	8 operations
`entries`	Entries	6 operations
`front`	Front / fronters	8 operations
`appearance`	Appearance	3 operations
`customFields`	Custom fields	7 operations
`trash`	Trash	2 operations
`search`	Search	5 operations
`subscriptions`	Subscriptions	1 operations
`activity`	Activity	1 operations
`memberStatuses`	Member statuses	16 operations
`systems`	Systems	10 operations
`messaging`	Messaging	47 operations
`privacyBuckets`	Privacy buckets	30 operations
`terminology`	Terminology	6 operations
`friends`	Friends	37 operations
`billing`	Billing	2 operations
`import`	Import	6 operations
`social`	Social profile	11 operations
`guestbook`	Guestbook	4 operations
`poll`	Poll	2 operations
`groupLayout`	Group layout	5 operations

members — Members

GET /api/v1/members/{memberId}/media — read
GET /api/v1/members/{memberId} — read
PATCH /api/v1/members/{memberId} — read_write
DELETE /api/v1/members/{memberId} — read_write
GET /api/v1/members/page — read
GET /api/v1/members — read
POST /api/v1/members — read_write

groups — Groups & folders

PATCH /api/v1/groups/{groupId}/icon — read_write
GET /api/v1/groups/{groupId}/path — read
GET /api/v1/groups/{groupId} — read
PATCH /api/v1/groups/{groupId} — read_write
DELETE /api/v1/groups/{groupId} — read_write
GET /api/v1/groups — read
POST /api/v1/groups — read_write
GET /api/v1/groups/tree — read

directories — Groups (legacy alias)

PATCH /api/v1/groups/{groupId}/icon — read_write
GET /api/v1/groups/{groupId}/path — read
GET /api/v1/groups/{groupId} — read
PATCH /api/v1/groups/{groupId} — read_write
DELETE /api/v1/groups/{groupId} — read_write
GET /api/v1/groups — read
POST /api/v1/groups — read_write
GET /api/v1/groups/tree — read

entries — Entries

POST /api/v1/entries/{entryId}/restore — read_write
GET /api/v1/entries/{entryId} — read
PATCH /api/v1/entries/{entryId} — read_write
DELETE /api/v1/entries/{entryId} — read_write
GET /api/v1/entries — read
POST /api/v1/entries — read_write

front — Front / fronters

GET /api/v1/front/history — read
DELETE /api/v1/front/members/{memberId} — read_write
POST /api/v1/front/members — read_write
PATCH /api/v1/front/order — read_write
GET /api/v1/front — read
DELETE /api/v1/front — read_write
DELETE /api/v1/front/tier-presence/{memberId} — read_write
POST /api/v1/front/tier-presence — read_write

appearance — Appearance

POST /api/v1/appearance/reset — read_write
GET /api/v1/appearance — read
PATCH /api/v1/appearance — read_write

customFields — Custom fields

POST /api/v1/members/{memberId}/custom-fields/{fieldId}/restore — read_write
PATCH /api/v1/members/{memberId}/custom-fields/{fieldId} — read_write
DELETE /api/v1/members/{memberId}/custom-fields/{fieldId} — read_write
PUT /api/v1/members/{memberId}/custom-fields/{fieldId}/value — read_write
POST /api/v1/members/{memberId}/custom-fields/reorder — read_write
GET /api/v1/members/{memberId}/custom-fields — read
POST /api/v1/members/{memberId}/custom-fields — read_write

trash — Trash

POST /api/v1/trash/purge — read_write
GET /api/v1/trash — read

search — Search

subscriptions — Subscriptions

GET /api/v1/subscriptions — read

activity — Activity

GET /api/v1/activity — read

memberStatuses — Member statuses

PUT /api/v1/member-statuses/{definitionId}/privacy-buckets — read_write
POST /api/v1/member-statuses/{definitionId}/restore — read_write
GET /api/v1/member-statuses/{definitionId} — read
PATCH /api/v1/member-statuses/{definitionId} — read_write
DELETE /api/v1/member-statuses/{definitionId} — read_write
GET /api/v1/member-statuses/assignments/account — read
POST /api/v1/member-statuses/assignments/account — read_write
POST /api/v1/member-statuses/assignments/active-front — read_write
POST /api/v1/member-statuses/assignments/members — read_write
POST /api/v1/member-statuses/assignments — read_write
POST /api/v1/member-statuses/assignments/unassign — read_write
POST /api/v1/member-statuses/reorder — read_write
GET /api/v1/member-statuses — read
POST /api/v1/member-statuses — read_write
GET /api/v1/members/{memberId}/statuses — read
DELETE /api/v1/members/{memberId}/statuses — read_write

systems — Systems

PATCH /api/v1/systems/active — read_write
GET /api/v1/systems — read
GET /api/v1/systems/side-systems/{sideSystemId}/assignable-members — read
PATCH /api/v1/systems/side-systems/{sideSystemId} — read_write
DELETE /api/v1/systems/side-systems/{sideSystemId} — read_write
POST /api/v1/systems/side-systems — read_write
PATCH /api/v1/systems/sub-systems/{subSystemId} — read_write
DELETE /api/v1/systems/sub-systems/{subSystemId} — read_write
POST /api/v1/systems/sub-systems — read_write
PATCH /api/v1/systems/unified-view — read_write

messaging — Messaging

GET /api/v1/messaging/attachments/{attachmentId}/access-url — read
POST /api/v1/messaging/attachments/complete — read_write
POST /api/v1/messaging/attachments/upload-intent — read_write
GET /api/v1/messaging/bootstrap — read
PATCH /api/v1/messaging/categories/{categoryId}/collapsed — read_write
PATCH /api/v1/messaging/categories/{categoryId} — read_write
DELETE /api/v1/messaging/categories/{categoryId} — read_write
GET /api/v1/messaging/channels/{channelId}/messages/around — read
GET /api/v1/messaging/channels/{channelId}/messages/newer — read
GET /api/v1/messaging/channels/{channelId}/messages — read
POST /api/v1/messaging/channels/{channelId}/messages — read_write
PATCH /api/v1/messaging/channels/{channelId}/move — read_write
DELETE /api/v1/messaging/channels/{channelId}/pins/{messageId} — read_write
GET /api/v1/messaging/channels/{channelId}/pins — read
POST /api/v1/messaging/channels/{channelId}/pins — read_write
POST /api/v1/messaging/channels/{channelId}/read — read_write
PATCH /api/v1/messaging/channels/{channelId} — read_write
DELETE /api/v1/messaging/channels/{channelId} — read_write
GET /api/v1/messaging/gifs/browse — read
GET /api/v1/messaging/gifs/categories — read
GET /api/v1/messaging/gifs/search — read
POST /api/v1/messaging/link-previews/{previewId}/dismiss — read_write
POST /api/v1/messaging/link-previews/{previewId}/refresh — read_write
GET /api/v1/messaging/mentions — read
PATCH /api/v1/messaging/messages/{messageId} — read_write
DELETE /api/v1/messaging/messages/{messageId} — read_write
GET /api/v1/messaging/preferences/chat-as-members — read
GET /api/v1/messaging/preferences/chat-as — read
PUT /api/v1/messaging/preferences/chat-as — read_write
GET /api/v1/messaging/preferences/emoji — read
PUT /api/v1/messaging/preferences/emoji — read_write
GET /api/v1/messaging/preferences/gif — read
PUT /api/v1/messaging/preferences/gif — read_write
PUT /api/v1/messaging/preferences/last-viewed-route — read_write
POST /api/v1/messaging/spaces/{spaceId}/categories/reorder — read_write
GET /api/v1/messaging/spaces/{spaceId}/categories — read
POST /api/v1/messaging/spaces/{spaceId}/categories — read_write
POST /api/v1/messaging/spaces/{spaceId}/channels/reorder — read_write
GET /api/v1/messaging/spaces/{spaceId}/channels — read
POST /api/v1/messaging/spaces/{spaceId}/channels — read_write
PATCH /api/v1/messaging/spaces/{spaceId} — read_write
DELETE /api/v1/messaging/spaces/{spaceId} — read_write
POST /api/v1/messaging/spaces/icon/complete — read_write
POST /api/v1/messaging/spaces/icon/upload-intent — read_write
POST /api/v1/messaging/spaces/reorder — read_write
GET /api/v1/messaging/spaces — read
POST /api/v1/messaging/spaces — read_write

privacyBuckets — Privacy buckets

GET /api/v1/privacy-buckets/{bucketId}/directories — read
GET /api/v1/privacy-buckets/{bucketId}/groups — read
GET /api/v1/privacy-buckets/{bucketId}/members — read
GET /api/v1/privacy-buckets/{bucketId} — read
PATCH /api/v1/privacy-buckets/{bucketId} — read_write
DELETE /api/v1/privacy-buckets/{bucketId} — read_write
GET /api/v1/privacy-buckets/assignments/custom-fields/{fieldDefinitionId} — read
PUT /api/v1/privacy-buckets/assignments/custom-fields/{fieldDefinitionId} — read_write
GET /api/v1/privacy-buckets/assignments/directories/{directoryId} — read
PUT /api/v1/privacy-buckets/assignments/directories/{directoryId} — read_write
GET /api/v1/privacy-buckets/assignments/friends/{friendUserId} — read
PUT /api/v1/privacy-buckets/assignments/friends/{friendUserId} — read_write
GET /api/v1/privacy-buckets/assignments/groups/{groupId} — read
PUT /api/v1/privacy-buckets/assignments/groups/{groupId} — read_write
GET /api/v1/privacy-buckets/assignments/members/{memberId} — read
PUT /api/v1/privacy-buckets/assignments/members/{memberId} — read_write
GET /api/v1/privacy-buckets/assignments/profile-sections/{memberId}/{sectionKey} — read
PUT /api/v1/privacy-buckets/assignments/profile-sections/{memberId}/{sectionKey} — read_write
GET /api/v1/privacy-buckets/assignments/side-systems/{sideSystemId} — read
PUT /api/v1/privacy-buckets/assignments/side-systems/{sideSystemId} — read_write
GET /api/v1/privacy-buckets/assignments/sub-systems/{subSystemId} — read
PUT /api/v1/privacy-buckets/assignments/sub-systems/{subSystemId} — read_write
POST /api/v1/privacy-buckets/bulk/directories — read_write
POST /api/v1/privacy-buckets/bulk/friends — read_write
POST /api/v1/privacy-buckets/bulk/groups — read_write
POST /api/v1/privacy-buckets/bulk/members — read_write
GET /api/v1/privacy-buckets/defaults/{kind} — read
PUT /api/v1/privacy-buckets/defaults/{kind} — read_write
GET /api/v1/privacy-buckets — read
POST /api/v1/privacy-buckets — read_write

terminology — Terminology

POST /api/v1/terminology/reset — read_write
GET /api/v1/terminology/resolved — read
GET /api/v1/terminology — read
PATCH /api/v1/terminology — read_write
PATCH /api/v1/terminology/scoped — read_write
POST /api/v1/terminology/scoped — read_write

friends — Friends

POST /api/v1/friends/{friendUserId}/block — read_write
PUT /api/v1/friends/{friendUserId}/custom-fields/{fieldId}/value — read_write
GET /api/v1/friends/{friendUserId}/custom-fields — read
PATCH /api/v1/friends/{friendUserId}/entries/{entryId} — read_write
DELETE /api/v1/friends/{friendUserId}/entries/{entryId} — read_write
GET /api/v1/friends/{friendUserId}/entries — read
POST /api/v1/friends/{friendUserId}/entries — read_write
GET /api/v1/friends/{friendUserId}/front/history/month — read
GET /api/v1/friends/{friendUserId}/front/history — read
DELETE /api/v1/friends/{friendUserId}/front/members/{memberId} — read_write
POST /api/v1/friends/{friendUserId}/front/members — read_write
PATCH /api/v1/friends/{friendUserId}/front/order — read_write
GET /api/v1/friends/{friendUserId}/front — read
PUT /api/v1/friends/{friendUserId}/front — read_write
DELETE /api/v1/friends/{friendUserId}/front/tier-presence/{memberId} — read_write
GET /api/v1/friends/{friendUserId}/front/writable-member-ids — read
GET /api/v1/friends/{friendUserId}/groups/folder/page — read
GET /api/v1/friends/{friendUserId}/groups/folder — read
GET /api/v1/friends/{friendUserId}/groups — read
GET /api/v1/friends/{friendUserId}/member-statuses/members/{memberId} — read
GET /api/v1/friends/{friendUserId}/member-statuses — read
GET /api/v1/friends/{friendUserId}/members/{memberId} — read
GET /api/v1/friends/{friendUserId}/members/page — read
GET /api/v1/friends/{friendUserId}/members — read
POST /api/v1/friends/{friendUserId}/request — read_write
POST /api/v1/friends/{friendUserId}/revoke — read_write
GET /api/v1/friends/{friendUserId} — read
POST /api/v1/friends/block-by-username — read_write
GET /api/v1/friends/page — read
POST /api/v1/friends/request-by-username — read_write
POST /api/v1/friends/requests/{requesterUserId}/accept — read_write
GET /api/v1/friends/requests — read
GET /api/v1/friends — read
GET /api/v1/friends/search/catalog — read
GET /api/v1/friends/search/members — read
GET /api/v1/friends/search — read
GET /api/v1/friends/suggestions — read

billing — Billing

GET /api/v1/billing/entitlements — read
GET /api/v1/billing/plan-usage — read

import — Import

GET /api/v1/import/active — read
GET /api/v1/import/latest — read
GET /api/v1/import/runs/{runId} — read
PATCH /api/v1/import/runs/{runId} — read_write
GET /api/v1/import/runs — read
POST /api/v1/import/start — read_write

guestbook — Guestbook

POST /api/v1/social/widgets/{widgetId}/guestbook/block-author — read_write
DELETE /api/v1/social/widgets/{widgetId}/guestbook/messages/{messageId} — read_write
GET /api/v1/social/widgets/{widgetId}/guestbook — read
POST /api/v1/social/widgets/{widgetId}/guestbook — read_write

poll — Poll

GET /api/v1/social/widgets/{widgetId}/poll — read
POST /api/v1/social/widgets/{widgetId}/poll — read_write

groupLayout — Group layout

GET /api/v1/groups/{groupId}/layout — read
PUT /api/v1/groups/{groupId}/layout — read_write
POST /api/v1/groups/{groupId}/layout/separators — read_write
PATCH /api/v1/groups/layout/separators/{id} — read_write
DELETE /api/v1/groups/layout/separators/{id} — read_write

Groups and the legacy directories scope

Groups and folder routes use the higher access level of groups and directories. Either one can satisfy the requirement; they are not two separate permissions that both need granting. The dashboard’s Groups & folders control sets both together. groupLayout is a separate scope.

Scopes do not grant access to another account

Friend routes require the friends API scope, then evaluate friendship and privacy permissions. Bucket permissions such as members.profile.read are separate from API-key scope names. Enabling friends: read_write does not bypass the owner’s sharing rules.