List custom fields
Returns custom fields accessible to the API key’s account.
GET
/api/v1/members/{memberId}/custom-fieldscustomFields: 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 |
|---|---|---|---|
memberId | string (uuid) | Required | Identifier of the member. |
Response schema
200
Successful response.
| Name | Type | Required | Description |
|---|---|---|---|
type | string | Required | Type. |
id | string | Required | Unique identifier. |
userId | string | Required | Owning account identifier. |
description | null | string | Required | Description of the resource. |
memberId | null | string | Required | Associated member identifier. |
icon | null | string | Required | Icon. |
deletedAt | null | number | Required | Deletion time; null when active. |
purgeAt | null | number | Required | Purge At. |
background | null | string | Required | Background storage reference. |
label | string | Required | Label. |
orderIndex | number | Required | Order Index. |
colSpan | number | Required | Col Span. |
rowSpan | number | Required | Row Span. |
required | null | boolean | Required | Required. |
value | null | string | array<string> | Required | Value. |
ownerUserId | string | Optional | Owner User Id. |
privacyBucketIds | array<string> | Required | Privacy Bucket Ids. Privacy bucket ids for friend visibility; at least one once configured (legacy rows may be empty). |
Errors
400· JSON errorMissing member id.
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires customFields: read; ownership or feature restrictions may also deny access.
404· JSON errorRequest failed (NOT_FOUND).
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/members/11111111-1111-4111-8111-111111111111/custom-fields' \
--header "Authorization: Bearer $FLORALITY_KEY"Responses
Successful response.
[
{
"type": "demo",
"id": "11111111-1111-4111-8111-111111111111",
"userId": "11111111-1111-4111-8111-111111111111",
"description": null,
"memberId": null,
"icon": null,
"deletedAt": null,
"purgeAt": null,
"background": null,
"label": "demo",
"orderIndex": 0,
"colSpan": 0,
"rowSpan": 0,
"required": null,
"value": null,
"ownerUserId": "11111111-1111-4111-8111-111111111111",
"privacyBucketIds": [
"11111111-1111-4111-8111-111111111111"
]
}
]Example values are illustrative demo data.