Get friend front
Returns friend front for the authorised account.
GET
/api/v1/friends/{friendUserId}/frontfriends: 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. |
Response schema
200
Successful response.
| Name | Type | Required | Description |
|---|---|---|---|
primary | null | null | object | Required | Primary. |
alsoFronting | array<JSON value> | array<object> | Required | Also Fronting. |
tieredMembers | array<JSON value> | array<object> | Required | Tiered Members. |
note | JSON value | string | Optional | Note. |
frontTypes | array<JSON value> | array<object> | Required | Front Types. |
primaryTypeKey | string | Required | Primary Type Key. |
alsoFrontingTypeKey | string | Required | Also Fronting Type Key. |
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.
curl --request GET 'https://floralitys.com/api/v1/friends/11111111-1111-4111-8111-111111111111/front' \
--header "Authorization: Bearer $FLORALITY_KEY"Responses
Successful response.
{
"primary": null,
"alsoFronting": [
{
"member": {
"_id": "11111111-1111-4111-8111-111111111111",
"userId": "11111111-1111-4111-8111-111111111111",
"directoryId": "11111111-1111-4111-8111-111111111111",
"sideSystemId": "11111111-1111-4111-8111-111111111111",
"subSystemId": "11111111-1111-4111-8111-111111111111",
"name": "River",
"displayName": "River",
"pronouns": "they/them",
"avatar": "demo",
"about": "A note from our demo system.",
"aboutTags": [
"A note from our demo system."
],
"background": "demo",
"createdAt": 1767225600000,
"updatedAt": 1767225600000,
"profileStyle": null,
"avatarUrl": null,
"backgroundUrl": null,
"linkedSubSystems": [
{
"_id": "11111111-1111-4111-8111-111111111111",
"name": "River",
"sideSystemId": "11111111-1111-4111-8111-111111111111"
}
]
},
"activeSession": {
"_id": "11111111-1111-4111-8111-111111111111",
"userId": "11111111-1111-4111-8111-111111111111",
"memberId": "11111111-1111-4111-8111-111111111111",
"sideSystemId": null,
"subSystemId": null,
"startedAt": 1767225600000,
"endedAt": 1767225600000,
"note": "demo",
"createdBy": "demo",
"createdManually": false,
"editedAt": 1767225600000,
"editedManually": false,
"typeKey": null
},
"typeKey": "demo"
}
],
"tieredMembers": [
{
"member": {
"_id": "11111111-1111-4111-8111-111111111111",
"userId": "11111111-1111-4111-8111-111111111111",
"directoryId": "11111111-1111-4111-8111-111111111111",
"sideSystemId": "11111111-1111-4111-8111-111111111111",
"subSystemId": "11111111-1111-4111-8111-111111111111",
"name": "River",
"displayName": "River",
"pronouns": "they/them",
"avatar": "demo",
"about": "A note from our demo system.",
"aboutTags": [
"A note from our demo system."
],
"background": "demo",
"createdAt": 1767225600000,
"updatedAt": 1767225600000,
"profileStyle": null,
"avatarUrl": null,
"backgroundUrl": null,
"linkedSubSystems": [
{
"_id": "11111111-1111-4111-8111-111111111111",
"name": "River",
"sideSystemId": "11111111-1111-4111-8111-111111111111"
}
]
},
"tierKey": "demo",
"tierDisplayName": "River",
"note": "demo"
}
],
"note": "demo",
"frontTypes": [
{
"key": "demo",
"name": "River",
"icon": "demo",
"iconType": "emoji",
"colour": null,
"assignmentMode": "session",
"enabled": true,
"isDefault": false,
"position": 0
}
],
"primaryTypeKey": "demo",
"alsoFrontingTypeKey": "demo"
}Example values are illustrative demo data.