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 member statuses definitionid
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
Member statusesList member status definition holders

List member status definition holders

Returns member status definition holders accessible to the API key’s account.

GET
/api/v1/member-statuses/{definitionId}
memberStatuses: 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
definitionIdstring (uuid)RequiredIdentifier of the definition.

Query parameters

NameTypeRequiredDescription
holdersstringOptionalOptional holders value.

Response schema

200

Successful response.

NameTypeRequiredDescription
assignmentIdstringOptionalAssignment Id.
targetKindstringOptionalTarget Kind. Allowed values: "member", "active_front", "account".
memberIdnull | stringOptionalAssociated member identifier.
memberNamenull | stringOptionalMember Name.
memberDisplayNamenull | stringOptionalMember Display Name.
idstringOptionalUnique identifier.
userIdstringOptionalOwning account identifier.
namestringOptionalName of the resource.
descriptionnull | stringOptionalDescription of the resource.
iconstringOptionalIcon.
iconTypestringOptionalIcon Type. Allowed values: "custom", "emoji", "lucide".
colournull | stringOptionalColour.
avatarRingShapenull | stringOptionalAvatar Ring Shape.
positionnumberOptionalPosition.
deletedAtnull | numberOptionalDeletion time; null when active.
purgeAtnull | numberOptionalPurge At.
createdAtnumberOptionalCreation time.
updatedAtnumberOptionalMost recent update time.
privacyBucketIdsarray<string>OptionalPrivacy Bucket Ids.

Errors

400 · JSON error

Missing definition id.

401 · JSON error

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

403 · JSON error

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

404 · JSON error

Request failed (NOT_FOUND).

429 · JSON error

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

← Previous endpointRestore member status definitionNext endpoint →Update member status definition

Request example

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

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

Responses

Successful response.

JSON
{
  "id": "11111111-1111-4111-8111-111111111111",
  "userId": "11111111-1111-4111-8111-111111111111",
  "name": "River",
  "description": null,
  "icon": "demo",
  "iconType": "custom",
  "colour": null,
  "avatarRingShape": null,
  "position": 0,
  "deletedAt": null,
  "purgeAt": null,
  "createdAt": 1767225600000,
  "updatedAt": 1767225600000,
  "privacyBucketIds": [
    "11111111-1111-4111-8111-111111111111"
  ]
}

Example values are illustrative demo data.