Friends
Friendship requests and relationships govern access to shared profiles, members, notes and front data.
Object schema
Fields returned by List friends (one item from the collection). Individual endpoint pages document their complete response shapes.
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Unique identifier. |
friendUserId | string | Required | Friend User Id. |
status | string | Required | Status. Allowed values: "pending", "accepted", "blocked", "revoked". |
name | string | Required | Name of the resource. |
username | null | string | Required | Username. |
imageUrl | null | string | Required | Image Url. |
friendPronouns | null | string | Required | Friend Pronouns. |
friendStatus | null | string | Required | Friend Status. |
friendBannerUrl | null | string | Required | Friend Banner Url. Resolved banner for list rows; null if unset or not embeddable. |
isAdmin | boolean | Required | Is Admin. |
planKey | null | string | Required | Plan Key. |
donorSupporterUnlocked | boolean | Required | Donor Supporter Unlocked. |
closedBetaParticipantAt | null | number | Required | Closed Beta Participant At. |
bugBountyUnlockedAt | null | number | Required | Bug Bounty Unlocked At. |
privacyBucketIds | array<string> | Required | Privacy Bucket Ids. Owner-assigned privacy bucket ids for this friend (empty if legacy / not configured). |
friendProfileStyle | null | object | Required | Friend Profile Style. |
friendProfileStyle.avatarRing | object | Optional | Avatar Ring. |
friendProfileStyle.avatarRing.show | boolean | Optional | Show. Allowed values: false, true. |
friendProfileStyle.avatarRing.colorHex | null | string | Optional | Color Hex. |
friendProfileStyle.avatarRing.shape | string | Optional | Shape. Allowed values: "moon", "circle", "square", "hexagon", "octagon", "star", "pentagon", "heart", "shield", "sakura", "neko", "butterfly", "sparkle", "crown". |
friendProfileStyle.avatarRing.gradient | null | object | Optional | Gradient. |
friendProfileStyle.avatarRing.animation | string | Optional | Animation. Allowed values: "none", "pulse", "rotate", "shimmer". |
friendProfileStyle.avatarRing.animationSpeed | number | Optional | Animation Speed. |
friendProfileStyle.avatarRing.strokeStyle | string | Optional | Stroke Style. Allowed values: "single", "double", "glow". |
friendProfileStyle.avatarRing.customMaskStorageId | string | Optional | Custom Mask Storage Id. |
friendProfileStyle.avatarRing.customMaskPathD | string | Optional | Custom Mask Path D. |
friendProfileStyle.bannerFrame | object | Optional | Banner Frame. |
friendProfileStyle.bannerFrame.colorHex | null | string | Optional | Color Hex. |
friendProfileStyle.bannerFrame.showBorder | boolean | Optional | Show Border. Allowed values: false, true. |
friendProfileStyle.bannerFrame.borderWidthPx | number | Optional | Border Width Px. |
friendProfileStyle.bannerFrame.borderStyle | string | Optional | Border Style. Allowed values: "none", "double", "solid", "dashed". |
friendProfileStyle.bannerFrame.cornerStyle | string | Optional | Corner Style. Allowed values: "default", "rounded", "sharp". |
friendProfileStyle.memberName | object | Optional | Member Name. |
friendProfileStyle.memberName.fontFamily | null | string | Optional | Font Family. |
friendProfileStyle.memberName.customFontId | null | string | Optional | Custom Font Id. |
friendProfileStyle.memberName.colorHex | null | string | Optional | Color Hex. |
friendProfileStyle.memberName.gradient | null | object | Optional | Gradient. |
friendProfileStyle.memberName.letterSpacing | string | Optional | Letter Spacing. Allowed values: "normal", "wide". |
friendProfileStyle.memberName.smallCaps | boolean | Optional | Small Caps. Allowed values: false, true. |
friendProfileStyle.memberName.textShadow | boolean | Optional | Text Shadow. Allowed values: false, true. |
friendProfileStyle.memberName.nameEffect | string | Optional | Name Effect. Allowed values: "none", "shimmer", "soft-glow". |
friendProfileStyle.bannerImage | object | Optional | Banner Image. |
friendProfileStyle.bannerImage.brightness | number | Optional | Brightness. |
friendProfileStyle.bannerImage.contrast | number | Optional | Contrast. |
friendProfileStyle.bannerImage.tintHex | null | string | Optional | Tint Hex. |
friendProfileStyle.bannerImage.tintOpacity | number | Optional | Tint Opacity. |
friendProfileStyle.avatarImage | object | Optional | Avatar Image. |
friendProfileStyle.avatarImage.brightness | number | Optional | Brightness. |
friendProfileStyle.avatarImage.contrast | number | Optional | Contrast. |
friendProfileStyle.avatarImage.tintHex | null | string | Optional | Tint Hex. |
friendProfileStyle.avatarImage.tintOpacity | number | Optional | Tint Opacity. |
friendProfileStyle.bannerOverlay | string | Optional | Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid". |
friendProfileStyle.profileBackgroundPattern | string | Optional | Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise". |
friendProfileStyle.heroLayout | string | Optional | Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left". |
friendProfileStyle.accentColorHex | null | string | Optional | Accent Color Hex. |
friendProfileStyle.profileBackgroundFill | object | Optional | Profile Background Fill. |
friendProfileStyle.profileBackgroundFill.mode | string | Optional | Mode. Allowed values: "default", "gradient", "solid". |
friendProfileStyle.profileBackgroundFill.gradient | null | object | Optional | Gradient. |
friendProfileStyle.profileBackgroundFill.solidHex | null | string | Optional | Solid Hex. |
friendProfileStyle.pageBackgroundFill | object | Optional | Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient). |
friendProfileStyle.pageBackgroundFill.mode | string | Optional | Mode. Allowed values: "default", "gradient", "solid". |
friendProfileStyle.pageBackgroundFill.gradient | null | object | Optional | Gradient. |
friendProfileStyle.pageBackgroundFill.solidHex | null | string | Optional | Solid Hex. |
friendProfileStyle.panelBackgroundFill | object | Optional | Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient). |
friendProfileStyle.panelBackgroundFill.mode | string | Optional | Mode. Allowed values: "default", "gradient", "solid". |
friendProfileStyle.panelBackgroundFill.gradient | null | object | Optional | Gradient. |
friendProfileStyle.panelBackgroundFill.solidHex | null | string | Optional | Solid Hex. |
friendProfileStyle.panelFillAccentHex | null | string | Optional | Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+). |
friendProfileStyle.panelCardAccentHex | null | string | Optional | Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+). |
createdAt | number | Required | Creation time. |
acceptedAt | null | number | Required | Accepted At. |
Endpoints
38 operations
POSTBlock friend
/api/v1/friends/{friendUserId}/blockPUTSet friend custom field value/api/v1/friends/{friendUserId}/custom-fields/{fieldId}/valueGETList friend custom fields/api/v1/friends/{friendUserId}/custom-fieldsPATCHUpdate friend entry/api/v1/friends/{friendUserId}/entries/{entryId}DELETEDelete friend entry/api/v1/friends/{friendUserId}/entries/{entryId}GETList friend entries/api/v1/friends/{friendUserId}/entriesPOSTCreate friend entry/api/v1/friends/{friendUserId}/entriesGETGet friend front history month/api/v1/friends/{friendUserId}/front/history/monthGETList friend front history/api/v1/friends/{friendUserId}/front/historyDELETERemove friend front member/api/v1/friends/{friendUserId}/front/members/{memberId}POSTAdd friend front member/api/v1/friends/{friendUserId}/front/membersPATCHReorder friend front/api/v1/friends/{friendUserId}/front/orderGETGet friend front/api/v1/friends/{friendUserId}/frontPUTSet friend sole front/api/v1/friends/{friendUserId}/frontDELETERemove friend front tier/api/v1/friends/{friendUserId}/front/tier-presence/{memberId}GETList friend front writable member ids/api/v1/friends/{friendUserId}/front/writable-member-idsGETGet friend groups folder page/api/v1/friends/{friendUserId}/groups/folder/pageGETGet friend groups folder/api/v1/friends/{friendUserId}/groups/folderGETList friend groups tree/api/v1/friends/{friendUserId}/groupsGETList friend member statuses for member/api/v1/friends/{friendUserId}/member-statuses/members/{memberId}GETList friend member statuses account/api/v1/friends/{friendUserId}/member-statusesGETGet friend member profile/api/v1/friends/{friendUserId}/members/{memberId}GETList friend members page/api/v1/friends/{friendUserId}/members/pageGETList friend members/api/v1/friends/{friendUserId}/membersPOSTCreate friend request/api/v1/friends/{friendUserId}/requestPOSTRevoke friendship/api/v1/friends/{friendUserId}/revokeGETGet friend profile/api/v1/friends/{friendUserId}GETGet friend social/api/v1/friends/{friendUserId}/socialPOSTBlock user by username/api/v1/friends/block-by-usernameGETList friends page/api/v1/friends/pagePOSTCreate friend request by username/api/v1/friends/request-by-usernamePOSTAccept friend request/api/v1/friends/requests/{requesterUserId}/acceptGETList friend requests/api/v1/friends/requestsGETList friends/api/v1/friendsGETFriends search catalog/api/v1/friends/search/catalogGETFriends search members/api/v1/friends/search/membersGETFriends search all/api/v1/friends/searchGETList friend suggestions/api/v1/friends/suggestions