Members
Members represent people within an account’s system, including profile information and media.
Object schema
Fields returned by Get member. Individual endpoint pages document their complete response shapes.
| Name | Type | Required | Description |
|---|---|---|---|
_id | string | Required | Unique identifier. |
userId | string | Required | Owning account identifier. |
directoryId | string | Required | Containing folder identifier. |
sideSystemId | string | Optional | Side System Id. |
subSystemId | string | Optional | Sub System Id. |
name | string | Required | Name of the resource. |
displayName | string | Optional | Display name. Privacy-bucket-sensitive in friend-facing responses. |
pronouns | string | Optional | Member pronouns. Privacy-bucket-sensitive in friend-facing responses. |
avatar | string | Optional | Avatar storage reference. Privacy-bucket-sensitive in friend-facing responses. |
about | string | Optional | Member profile text. Privacy-bucket-sensitive in friend-facing responses. |
aboutTags | array<string> | Required | Tags attached to the profile text. Labels shown on the member About card (same semantics as custom-field tags). Privacy-bucket-sensitive in friend-facing responses. |
background | string | Optional | Background storage reference. Privacy-bucket-sensitive in friend-facing responses. |
archivedAt | number | Optional | Archiving time; null when active. |
createdAt | number | Optional | Creation time. |
updatedAt | number | Optional | Most recent update time. |
deletedAt | number | Optional | Deletion time; null when active. |
purgeAt | number | Optional | Purge At. |
originalDirectoryId | string | Optional | Original Directory Id. |
profileStyle | null | object | Required | Profile presentation settings. Privacy-bucket-sensitive in friend-facing responses. |
profileStyle.avatarRing | object | Optional | Avatar Ring. |
profileStyle.avatarRing.show | boolean | Optional | Show. Allowed values: false, true. |
profileStyle.avatarRing.colorHex | null | string | Optional | Color Hex. |
profileStyle.avatarRing.shape | string | Optional | Shape. Allowed values: "moon", "circle", "square", "hexagon", "octagon", "star", "pentagon", "heart", "shield", "sakura", "neko", "butterfly", "sparkle", "crown". |
profileStyle.avatarRing.gradient | null | object | Optional | Gradient. |
profileStyle.avatarRing.animation | string | Optional | Animation. Allowed values: "none", "pulse", "rotate", "shimmer". |
profileStyle.avatarRing.animationSpeed | number | Optional | Animation Speed. |
profileStyle.avatarRing.strokeStyle | string | Optional | Stroke Style. Allowed values: "single", "double", "glow". |
profileStyle.avatarRing.customMaskStorageId | string | Optional | Custom Mask Storage Id. |
profileStyle.avatarRing.customMaskPathD | string | Optional | Custom Mask Path D. |
profileStyle.bannerFrame | object | Optional | Banner Frame. |
profileStyle.bannerFrame.colorHex | null | string | Optional | Color Hex. |
profileStyle.bannerFrame.showBorder | boolean | Optional | Show Border. Allowed values: false, true. |
profileStyle.bannerFrame.borderWidthPx | number | Optional | Border Width Px. |
profileStyle.bannerFrame.borderStyle | string | Optional | Border Style. Allowed values: "none", "double", "solid", "dashed". |
profileStyle.bannerFrame.cornerStyle | string | Optional | Corner Style. Allowed values: "default", "rounded", "sharp". |
profileStyle.memberName | object | Optional | Member Name. |
profileStyle.memberName.fontFamily | null | string | Optional | Font Family. |
profileStyle.memberName.customFontId | null | string | Optional | Custom Font Id. |
profileStyle.memberName.colorHex | null | string | Optional | Color Hex. |
profileStyle.memberName.gradient | null | object | Optional | Gradient. |
profileStyle.memberName.letterSpacing | string | Optional | Letter Spacing. Allowed values: "normal", "wide". |
profileStyle.memberName.smallCaps | boolean | Optional | Small Caps. Allowed values: false, true. |
profileStyle.memberName.textShadow | boolean | Optional | Text Shadow. Allowed values: false, true. |
profileStyle.memberName.nameEffect | string | Optional | Name Effect. Allowed values: "none", "shimmer", "soft-glow". |
profileStyle.bannerImage | object | Optional | Banner Image. |
profileStyle.bannerImage.brightness | number | Optional | Brightness. |
profileStyle.bannerImage.contrast | number | Optional | Contrast. |
profileStyle.bannerImage.tintHex | null | string | Optional | Tint Hex. |
profileStyle.bannerImage.tintOpacity | number | Optional | Tint Opacity. |
profileStyle.avatarImage | object | Optional | Avatar Image. |
profileStyle.avatarImage.brightness | number | Optional | Brightness. |
profileStyle.avatarImage.contrast | number | Optional | Contrast. |
profileStyle.avatarImage.tintHex | null | string | Optional | Tint Hex. |
profileStyle.avatarImage.tintOpacity | number | Optional | Tint Opacity. |
profileStyle.bannerOverlay | string | Optional | Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid". |
profileStyle.profileBackgroundPattern | string | Optional | Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise". |
profileStyle.heroLayout | string | Optional | Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left". |
profileStyle.accentColorHex | null | string | Optional | Accent Color Hex. |
profileStyle.profileBackgroundFill | object | Optional | Profile Background Fill. |
profileStyle.profileBackgroundFill.mode | string | Optional | Mode. Allowed values: "default", "gradient", "solid". |
profileStyle.profileBackgroundFill.gradient | null | object | Optional | Gradient. |
profileStyle.profileBackgroundFill.solidHex | null | string | Optional | Solid Hex. |
profileStyle.pageBackgroundFill | object | Optional | Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient). |
profileStyle.pageBackgroundFill.mode | string | Optional | Mode. Allowed values: "default", "gradient", "solid". |
profileStyle.pageBackgroundFill.gradient | null | object | Optional | Gradient. |
profileStyle.pageBackgroundFill.solidHex | null | string | Optional | Solid Hex. |
profileStyle.panelBackgroundFill | object | Optional | Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient). |
profileStyle.panelBackgroundFill.mode | string | Optional | Mode. Allowed values: "default", "gradient", "solid". |
profileStyle.panelBackgroundFill.gradient | null | object | Optional | Gradient. |
profileStyle.panelBackgroundFill.solidHex | null | string | Optional | Solid Hex. |
profileStyle.panelFillAccentHex | null | string | Optional | Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+). |
profileStyle.panelCardAccentHex | null | string | Optional | Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+). |
avatarUrl | null | string | Required | Resolved avatar URL, or null when unavailable. Privacy-bucket-sensitive in friend-facing responses. |
backgroundUrl | null | string | Required | Resolved background URL, or null when unavailable. Privacy-bucket-sensitive in friend-facing responses. |
linkedSubSystems | array<object> | Optional | Linked Sub Systems. Sub systems that list this member as their linked profile (`sub_systems.linked_member_id`). Distinct from `subSystemId` (member row lives inside a sub system). |
linkedSubSystems[]._id | string | Required | Unique identifier. |
linkedSubSystems[].name | string | Required | Name of the resource. |
linkedSubSystems[].sideSystemId | string | Required | Side System Id. |
Friend-visible fields
Member visibility and individual profile sections are filtered for friend callers. Owner requests are not redacted by this friend-view filter. The friend endpoint pages describe the omitted fields and null values.
Endpoints
7 operations