List friend custom fields
Returns friend custom fields accessible to the API key’s account.
GET
/api/v1/friends/{friendUserId}/custom-fieldsfriends: 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 |
|---|---|---|---|
friendUserId | string (uuid) | Required | Identifier of the friend user. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
memberId | string (uuid) | Required | Filter or option: member id. |
Response schema
200
Successful response.
| Name | Type | Required | Description |
|---|---|---|---|
fields | array<JSON value> | array<object> | Required | Fields. |
emptyHint | string | null | Required | Empty Hint. |
Errors
400· JSON errorMissing friend user id.
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires friends: 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.
Responses
Successful response.
Example values are illustrative demo data.