> Portal Navigation:
>
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt
# GetMemberAbout
# Package: memberManagement
# Namespace: MembersAbout
# Method link: https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members-about-v2/get-member-about.md
## Permission Scopes:
Read Members: SCOPE.DC-MEMBERS.READ-MEMBERS
## Introduction
Retrieves a member's "About" section content.
---
## REST API
### Schema
```
Method: getMemberAbout
Description: Retrieves a member's "About" section content.
URL: https://www.wixapis.com/members/v2/abouts/{id}
Method: GET
# Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
Required parameters: id
Method parameters:
param name: id | type: none | required: true
Return type: GetMemberAboutResponse
- name: memberAbout | type: MemberAbout | description: The retrieved "About" section content.
- name: id | type: string | description: GUID of the "About" section content.
- name: revision | type: string | description: Revision number, which increments by 1 each time the "About" section content is updated. To prevent conflicting changes, the existing revision must be used when updating an "About" section content.
- name: memberId | type: string | description: Member GUID.
- name: content | type: RichContent | description: Fallback Message for SSR and Error .
- name: nodes | type: array | description: Node objects representing a rich content document.
- ONE-OF:
- name: buttonData | type: ButtonData | description: Data for a button node.
- name: containerData | type: PluginContainerData | description: Styling for the button's container.
- name: width | type: Width | description: The width of the node when it's displayed.
- ONE-OF:
- name: size | type: Type | description: One of the following predefined width options: `CONTENT`: The width of the container matches the content width. `SMALL`: A small width. `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width. `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
- enum:
- CONTENT: Width matches the content width
- SMALL: Small Width
- ORIGINAL: Width will match the original asset width
- FULL_WIDTH: coast-to-coast display
- name: custom | type: string | description: A custom width value in pixels.
- name: alignment | type: Alignment | description: The node's alignment within its container.
- enum:
- CENTER: Center Alignment
- LEFT: Left Alignment
- RIGHT: Right Alignment
- name: spoiler | type: Spoiler | description: Spoiler cover settings for the node.
- name: enabled | type: boolean | description: Sets whether the spoiler cover is enabled for this node. Defaults to `false`.
- name: description | type: string | description: The description displayed on top of the spoiler cover.
- name: buttonText | type: string | description: The text for the button used to remove the spoiler cover.
- name: height | type: Height | description: The height of the node when it's displayed.
- name: custom | type: string | description: A custom height value in pixels.
- name: textWrap | type: boolean | description: Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`.
- name: type | type: Type | description: The button type.
- enum:
- LINK: Regular link button
- ACTION: Triggers custom action that is defined in plugin configuration by the consumer
- name: styles | type: Styles | description: Styling for the button.
- name: borderWidth | type: integer | description: Border width in pixels.
- name: borderRadius | type: integer | description: Border radius in pixels.
- name: borderColor | type: string | description: Border color as a hexadecimal value.
- name: borderColorHover | type: string | description: Border color as a hexadecimal value (hover state).
- name: textColor | type: string | description: Text color as a hexadecimal value.
- name: textColorHover | type: string | description: Text color as a hexadecimal value (hover state).
- name: buttonSize | type: string | description: Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`.
- name: background | type: Background | description: Background styling (color or gradient).
- name: type | type: Type | description: Background type.
- enum:
- COLOR: Solid color background
- GRADIENT: Gradient background
- name: color | type: string | description: Background color as a hexadecimal value.
- name: gradient | type: Gradient | description: Gradient configuration.
- name: type | type: Type | description: Gradient type.
- enum:
- LINEAR: Linear gradient.
- RADIAL: Radial gradient.
- name: stops | type: array | description: Color stops for the gradient.
- name: color | type: string | description: Stop color as hex value.
- name: position | type: number | description: Stop position (0-1).
- name: angle | type: integer | description: Angle in degrees for linear gradient (0-360).
- name: centerX | type: number | description: Horizontal center position for radial gradient (0-100).
- name: centerY | type: number | description: Vertical center position for radial gradient (0-100).
- name: backgroundHover | type: Background | description: Background styling for hover state (color or gradient).
- name: text | type: string | description: The text to display on the button.
- name: link | type: Link | description: Button link details.
- ONE-OF:
- name: url | type: string | description: The absolute URL for the linked document.
- name: anchor | type: string | description: The target node's GUID. Used for linking to another node in this object.
- name: target | type: Target | description: he HTML `target` attribute value for the link. This property defines where the linked document opens as follows: `SELF` - Default. Opens the linked document in the same frame as the link. `BLANK` - Opens the linked document in a new browser tab or window. `PARENT` - Opens the linked document in the link's parent frame. `TOP` - Opens the linked document in the full body of the link's browser tab or window.
- enum:
- SELF: Opens the linked document in the same frame as it was clicked (this is default)
- BLANK: Opens the linked document in a new window or tab
- PARENT: Opens the linked document in the parent frame
- TOP: Opens the linked document in the full body of the window
- name: rel | type: Rel | description: The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document.
- name: nofollow | type: boolean | description: Indicates to search engine crawlers not to follow the link. Defaults to `false`.
- name: sponsored | type: boolean | description: Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`.
- name: ugc | type: boolean | description: Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`.
- name: noreferrer | type: boolean | description: Indicates that this link protect referral information from being passed to the target website.
- name: customData | type: string | description: A serialized object used for a custom or external link panel.
- name: codeBlockData | type: CodeBlockData | description: Data for a code block node.
- name: textStyle | type: TextStyle | description: Styling for the code block's text.
- name: textAlignment | type: TextAlignment | description: Text alignment. Defaults to `AUTO`.
- enum:
- AUTO: browser default, eqivalent to `initial`
- LEFT: Left align
- RIGHT: Right align
- CENTER: Center align
- JUSTIFY: Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line
- name: lineHeight | type: string | description: A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px.
- name: dividerData | type: DividerData | description: Data for a divider node.
- name: containerData | type: PluginContainerData | description: Styling for the divider's container.
- name: lineStyle | type: LineStyle | description: Divider line style.
- enum:
- SINGLE: Single Line
- DOUBLE: Double Line
- DASHED: Dashed Line
- DOTTED: Dotted Line
- name: width | type: Width | description: Divider width.
- enum:
- LARGE: Large line
- MEDIUM: Medium line
- SMALL: Small line
- name: alignment | type: Alignment | description: Divider alignment.
- enum:
- CENTER: Center alignment
- LEFT: Left alignment
- RIGHT: Right alignment
- name: fileData | type: FileData | description: Data for a file node.
- name: containerData | type: PluginContainerData | description: Styling for the file's container.
- name: src | type: FileSource | description: The source for the file's data.
- ONE-OF:
- name: url | type: string | description: The absolute URL for the file's source.
- name: id | type: string | description: An GUID that's resolved to a URL by a resolver function.
- name: private | type: boolean | description: Indicates whether the file's source is private. Defaults to `false`.
- name: name | type: string | description: File name.
- name: type | type: string | description: File type.
- name: pdfSettings | type: PDFSettings | description: Settings for PDF files.
- name: viewMode | type: ViewMode | description: PDF view mode. One of the following: `NONE` : The PDF isn't displayed. `FULL` : A full page view of the PDF is displayed. `MINI` : A mini view of the PDF is displayed.
- enum:
- NONE: No PDF view
- FULL: Full PDF view
- MINI: Mini PDF view
- name: disableDownload | type: boolean | description: Sets whether the PDF download button is disabled. Defaults to `false`.
- name: disablePrint | type: boolean | description: Sets whether the PDF print button is disabled. Defaults to `false`.
- name: mimeType | type: string | description: File MIME type.
- name: path | type: string | description: File path.
- name: sizeInKb | type: string | description: File size in KB.
- name: galleryData | type: GalleryData | description: Data for a gallery node.
- name: containerData | type: PluginContainerData | description: Styling for the gallery's container.
- name: items | type: array- | description: The items in the gallery.
- ONE-OF:
- name: image | type: Image | description: An image item.
- name: media | type: Media | description: Image file details.
- name: src | type: FileSource | description: The source for the media's data.
- name: width | type: integer | description: Media width in pixels.
- name: height | type: integer | description: Media height in pixels.
- name: duration | type: number | description: Media duration in seconds. Only relevant for audio and video files.
- name: link | type: Link | description: Link details for images that are links.
- name: video | type: Video | description: A video item.
- name: media | type: Media | description: Video file details.
- name: thumbnail | type: Media | description: Video thumbnail file details.
- name: title | type: string | description: Item title.
- name: altText | type: string | description: Item's alternative text.
- name: options | type: GalleryOptions | description: Options for defining the gallery's appearance.
- name: layout | type: Layout | description: Gallery layout.
- name: type | type: Type | description: Gallery layout type.
- enum:
- COLLAGE: Collage type
- MASONRY: Masonry type
- GRID: Grid type
- THUMBNAIL: Thumbnail type
- SLIDER: Slider type
- SLIDESHOW: Slideshow type
- PANORAMA: Panorama type
- COLUMN: Column type
- MAGIC: Magic type
- FULLSIZE: Fullsize images type
- name: horizontalScroll | type: boolean | description: Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`.
- name: orientation | type: Orientation | description: Gallery orientation.
- enum:
- ROWS: Rows Orientation
- COLUMNS: Columns Orientation
- name: numberOfColumns | type: integer | description: The number of columns to display on full size screens.
- name: mobileNumberOfColumns | type: integer | description: The number of columns to display on mobile screens.
- name: item | type: ItemStyle | description: Styling for gallery items.
- name: targetSize | type: integer | description: Desirable dimension for each item in pixels (behvaior changes according to gallery type)
- name: ratio | type: number | description: Item ratio
- name: crop | type: Crop | description: Sets how item images are cropped.
- enum:
- FILL: Crop to fill
- FIT: Crop to fit
- name: spacing | type: integer | description: The spacing between items in pixels.
- name: thumbnails | type: Thumbnails | description: Styling for gallery thumbnail images.
- name: placement | type: Alignment | description: Thumbnail alignment.
- enum:
- TOP: Top alignment
- RIGHT: Right alignment
- BOTTOM: Bottom alignment
- LEFT: Left alignment
- NONE: No thumbnail
- name: spacing | type: integer | description: Spacing between thumbnails in pixels.
- name: disableExpand | type: boolean | description: Sets whether the gallery's expand button is disabled. Defaults to `false`.
- name: disableDownload | type: boolean | description: Sets whether the gallery's download button is disabled. Defaults to `false`.
- name: gifData | type: GIFData | description: Data for a GIF node.
- name: containerData | type: PluginContainerData | description: Styling for the GIF's container.
- name: original | type: GIF | description: The source of the full size GIF.
- name: gif | type: string | description: GIF format URL.
- name: mp4 | type: string | description: MP4 format URL.
- name: still | type: string | description: Thumbnail URL.
- name: downsized | type: GIF | description: The source of the downsized GIF.
- name: height | type: integer | description: Height in pixels.
- name: width | type: integer | description: Width in pixels.
- name: gifType | type: GIFType | description: Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`.
- enum: NORMAL, STICKER
- name: headingData | type: HeadingData | description: Data for a heading node.
- name: level | type: integer | description: Heading level from 1-6.
- name: textStyle | type: TextStyle | description: Styling for the heading text.
- name: indentation | type: integer | description: Indentation level from 1-4.
- name: renderedLevel | type: integer | description: Rendered heading level for SEO/accessibility, overrides the HTML tag when set.
- name: htmlData | type: HTMLData | description: Data for an embedded HTML node.
- ONE-OF:
- name: url | type: string | description: The URL for the HTML code for the node.
- name: html | type: string | description: The HTML code for the node.
- name: widgetId | type: string | description: The WixelWidget GUID for AI_WIDGET source nodes.
- name: containerData | type: PluginContainerData | description: Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`.
- name: source | type: Source | description: The type of HTML code.
- enum: HTML, ADSENSE, AI, AI_WIDGET
- name: autoHeight | type: boolean | description: If container height is aligned with its content height. Defaults to `true`.
- name: imageData | type: ImageData | description: Data for an image node.
- name: containerData | type: PluginContainerData | description: Styling for the image's container.
- name: image | type: Media | description: Image file details.
- name: link | type: Link | description: Link details for images that are links.
- name: disableExpand | type: boolean | description: Sets whether the image expands to full screen when clicked. Defaults to `false`.
- name: altText | type: string | description: Image's alternative text.
- name: disableDownload | type: boolean | description: Sets whether the image's download button is disabled. Defaults to `false`.
- name: decorative | type: boolean | description: Sets whether the image is decorative and does not need an explanation. Defaults to `false`.
- name: styles | type: Styles | description: Styling for the image.
- name: border | type: Border | description: Border attributes.
- name: width | type: integer | description: Border width in pixels.
- name: color | type: string | description: Border color as a hexadecimal value.
- name: radius | type: integer | description: Border radius in pixels.
- name: linkPreviewData | type: LinkPreviewData | description: Data for a link preview node.
- name: containerData | type: PluginContainerData | description: Styling for the link preview's container.
- name: link | type: Link | description: Link details.
- name: title | type: string | description: Preview title.
- name: thumbnailUrl | type: string | description: Preview thumbnail URL.
- name: description | type: string | description: Preview description.
- name: html | type: string | description: The preview content as HTML.
- name: styles | type: Styles | description: Styling for the link preview.
- name: backgroundColor | type: string | description: Background color as a hexadecimal value.
- name: titleColor | type: string | description: Title color as a hexadecimal value.
- name: subtitleColor | type: string | description: Subtitle color as a hexadecimal value.
- name: linkColor | type: string | description: Link color as a hexadecimal value.
- name: borderWidth | type: integer | description: Border width in pixels.
- name: borderRadius | type: integer | description: Border radius in pixels.
- name: borderColor | type: string | description: Border color as a hexadecimal value.
- name: thumbnailPosition | type: Position | description: Position of thumbnail. Defaults to `START`.
- enum:
- START: Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts)
- END: Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts)
- TOP: Thumbnail positioned at the top
- HIDDEN: Thumbnail hidden and not displayed
- name: paragraphData | type: ParagraphData | description: Data for a paragraph node.
- name: textStyle | type: TextStyle | description: Styling for the paragraph text.
- name: indentation | type: integer | description: Indentation level from 1-4.
- name: level | type: integer | description: Paragraph level
- name: pollData | type: PollData | description: Data for a poll node.
- name: containerData | type: PluginContainerData | description: Styling for the poll's container.
- name: poll | type: Poll | description: Poll data.
- name: id | type: string | description: Poll GUID.
- name: title | type: string | description: Poll title.
- name: creatorId | type: string | description: Poll creator GUID.
- name: image | type: Media | description: Main poll image.
- name: options | type: array
| description: Voting options.
- name: id | type: string | description: Option GUID.
- name: title | type: string | description: Option title.
- name: image | type: Media | description: The image displayed with the option.
- name: settings | type: Settings | description: The poll's permissions and display settings.
- name: permissions | type: Permissions | description: Permissions settings for voting.
- name: view | type: ViewRole | description: Sets who can view the poll results.
- enum:
- CREATOR: Only Poll creator can view the results
- VOTERS: Anyone who voted can see the results
- EVERYONE: Anyone can see the results, even if one didn't vote
- name: vote | type: VoteRole | description: Sets who can vote.
- enum:
- SITE_MEMBERS: Logged in member
- ALL: Anyone
- name: allowMultipleVotes | type: boolean | description: Sets whether one voter can vote multiple times. Defaults to `false`.
- name: showVoters | type: boolean | description: Sets whether voters are displayed in the vote results. Defaults to `true`.
- name: showVotesCount | type: boolean | description: Sets whether the vote count is displayed. Defaults to `true`.
- name: layout | type: Layout | description: Layout settings for the poll and voting options.
- name: poll | type: PollLayout | description: Poll layout settings.
- name: type | type: Type | description: The layout for displaying the voting options.
- enum:
- LIST: List
- GRID: Grid
- name: direction | type: Direction | description: The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right.
- enum:
- LTR: Left-to-right
- RTL: Right-to-left
- name: enableImage | type: boolean | description: Sets whether to display the main poll image. Defaults to `false`.
- name: options | type: OptionLayout | description: Voting otpions layout settings.
- name: enableImage | type: boolean | description: Sets whether to display option images. Defaults to `false`.
- name: design | type: Design | description: Styling for the poll and voting options.
- name: poll | type: PollDesign | description: Styling for the poll.
- name: background | type: Background | description: Background styling.
- ONE-OF:
- name: color | type: string | description: The background color as a hexademical value.
- name: image | type: Media | description: An image to use for the background.
- name: gradient | type: Gradient | description: Details for a gradient background.
- name: angle | type: integer | description: The gradient angle in degrees.
- name: startColor | type: string | description: The start color as a hexademical value.
- name: lastColor | type: string | description: The end color as a hexademical value.
- name: type | type: Type | description: Background type. For each option, include the relevant details.
- enum:
- COLOR: Color background type
- IMAGE: Image background type
- GRADIENT: Gradiant background type
- name: borderRadius | type: integer | description: Border radius in pixels.
- name: options | type: OptionDesign | description: Styling for voting options.
- name: borderRadius | type: integer | description: Border radius in pixels.
- name: textData | type: TextData | description: Data for a text node. Used to apply decorations to text.
- name: text | type: string | description: The text to apply decorations to.
- name: decorations | type: array | description: The decorations to apply.
- ONE-OF:
- name: anchorData | type: AnchorData | description: Data for an anchor link decoration.
- name: anchor | type: string | description: The target node's GUID.
- name: colorData | type: ColorData | description: Data for a color decoration.
- name: background | type: string | description: The text's background color as a hexadecimal value.
- name: foreground | type: string | description: The text's foreground color as a hexadecimal value.
- name: linkData | type: LinkData | description: Data for an external link decoration.
- name: link | type: Link | description: Link details.
- name: mentionData | type: MentionData | description: Data for a mention decoration.
- name: name | type: string | description: The mentioned user's name.
- name: slug | type: string | description: The version of the user's name that appears after the `@` character in the mention.
- name: id | type: string | description: Mentioned user's GUID.
- name: fontSizeData | type: FontSizeData | description: Data for a font size decoration.
- name: unit | type: fontType | description: The units used for the font size.
- enum: PX, EM
- name: value | type: integer | description: Font size value.
- name: fontWeightValue | type: integer | description: Font weight for a bold decoration.
- name: italicData | type: boolean | description: Data for an italic decoration. Defaults to `true`.
- name: underlineData | type: boolean | description: Data for an underline decoration. Defaults to `true`.
- name: spoilerData | type: SpoilerData | description: Data for a spoiler decoration.
- name: id | type: string | description: Spoiler GUID.
- name: strikethroughData | type: boolean | description: Data for a strikethrough decoration. Defaults to `true`.
- name: superscriptData | type: boolean | description: Data for a superscript decoration. Defaults to `true`.
- name: subscriptData | type: boolean | description: Data for a subscript decoration. Defaults to `true`.
- name: fontFamilyData | type: FontFamilyData | description: Data for a font family decoration.
- name: value | type: string | description:
- name: type | type: Type | description: The type of decoration to apply.
- enum: BOLD, ITALIC, UNDERLINE, SPOILER, ANCHOR, MENTION, LINK, COLOR, FONT_SIZE, EXTERNAL, STRIKETHROUGH, SUPERSCRIPT, SUBSCRIPT, FONT_FAMILY
- name: appEmbedData | type: AppEmbedData | description: Data for an app embed node.
- ONE-OF:
- name: bookingData | type: BookingData | description: Data for embedded Wix Bookings content.
- name: durations | type: string | description: Booking duration in minutes.
- name: eventData | type: EventData | description: Data for embedded Wix Events content.
- name: scheduling | type: string | description: Event schedule.
- name: location | type: string | description: Event location.
- name: type | type: AppType | description: The type of Wix App content being embedded.
- enum: PRODUCT, EVENT, BOOKING
- name: itemId | type: string | description: The GUID of the embedded content.
- name: name | type: string | description: The name of the embedded content.
- name: url | type: string | description: The URL for the embedded content.
- name: image | type: Media | description: An image for the embedded content.
- name: hideImage | type: boolean | description: Whether to hide the image.
- name: hideTitle | type: boolean | description: Whether to hide the title.
- name: hidePrice | type: boolean | description: Whether to hide the price.
- name: hideDescription | type: boolean | description: Whether to hide the description (Event and Booking).
- name: hideDateTime | type: boolean | description: Whether to hide the date and time (Event).
- name: hideLocation | type: boolean | description: Whether to hide the location (Event).
- name: hideDuration | type: boolean | description: Whether to hide the duration (Booking).
- name: hideButton | type: boolean | description: Whether to hide the button.
- name: hideRibbon | type: boolean | description: Whether to hide the ribbon.
- name: buttonStyles | type: ButtonStyles | description: Button styling options.
- name: buttonText | type: string | description: Text to display on the button.
- name: borderWidth | type: integer | description: Border width in pixels.
- name: borderRadius | type: integer | description: Border radius in pixels.
- name: borderColor | type: string | description: Border color as a hexadecimal value.
- name: textColor | type: string | description: Text color as a hexadecimal value.
- name: backgroundColor | type: string | description: Background color as a hexadecimal value.
- name: borderColorHover | type: string | description: Border color as a hexadecimal value (hover state).
- name: textColorHover | type: string | description: Text color as a hexadecimal value (hover state).
- name: backgroundColorHover | type: string | description: Background color as a hexadecimal value (hover state).
- name: buttonSize | type: string | description: Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`.
- name: imageStyles | type: ImageStyles | description: Image styling options.
- name: hideImage | type: boolean | description: Whether to hide the image.
- name: imagePosition | type: Position | description: Position of image. Defaults to `START`.
- enum:
- START: Image positioned at the start (left in LTR layouts, right in RTL layouts)
- END: Image positioned at the end (right in LTR layouts, left in RTL layouts)
- TOP: Image positioned at the top
- name: aspectRatio | type: AspectRatio | description: Aspect ratio for the image. Defaults to `SQUARE`.
- enum:
- SQUARE: 1:1 aspect ratio
- RECTANGLE: 16:9 aspect ratio
- name: resizing | type: Resizing | description: How the image should be resized. Defaults to `FILL`.
- enum:
- FILL: Fill the container, may crop the image
- FIT: Fit the image within the container
- name: borderColor | type: string | description: Image border color as a hexadecimal value.
- name: borderWidth | type: integer | description: Image border width in pixels.
- name: borderRadius | type: integer | description: Image border radius in pixels.
- name: ribbonStyles | type: RibbonStyles | description: Ribbon styling options.
- name: ribbonText | type: string | description: Text to display on the ribbon.
- name: backgroundColor | type: string | description: Ribbon background color as a hexadecimal value.
- name: textColor | type: string | description: Ribbon text color as a hexadecimal value.
- name: borderColor | type: string | description: Ribbon border color as a hexadecimal value.
- name: borderWidth | type: integer | description: Ribbon border width in pixels.
- name: borderRadius | type: integer | description: Ribbon border radius in pixels.
- name: ribbonPlacement | type: Placement | description: Placement of the ribbon. Defaults to `IMAGE`.
- enum:
- IMAGE: Ribbon placed on the image
- PRODUCT_INFO: Ribbon placed on the product information
- name: cardStyles | type: CardStyles | description: Card styling options.
- name: backgroundColor | type: string | description: Card background color as a hexadecimal value.
- name: borderColor | type: string | description: Card border color as a hexadecimal value.
- name: borderWidth | type: integer | description: Card border width in pixels.
- name: borderRadius | type: integer | description: Card border radius in pixels.
- name: type | type: Type | description: Card type. Defaults to `CONTAINED`.
- enum:
- CONTAINED: Card with visible border and background
- FRAMELESS: Card without visible border
- name: alignment | type: Alignment | description: Content alignment. Defaults to `START`.
- enum:
- START: Content aligned to start (left in LTR layouts, right in RTL layouts)
- CENTER: Content centered
- END: Content aligned to end (right in LTR layouts, left in RTL layouts)
- name: titlePriceLayout | type: Layout | description: Layout for title and price. Defaults to `STACKED`.
- enum:
- STACKED: Elements stacked vertically
- SIDE_BY_SIDE: Elements arranged horizontally
- name: titleColor | type: string | description: Title text color as a hexadecimal value.
- name: textColor | type: string | description: Text color as a hexadecimal value.
- name: containerData | type: PluginContainerData | description: Styling for the app embed's container.
- name: pricingData | type: PricingData | description: Pricing data for embedded Wix App content.
- name: valueFrom | type: string | description: Minimum numeric price value as string (e.g., "10.99").
- name: valueTo | type: string | description: Maximum numeric price value as string (e.g., "19.99").
- name: discountedValue | type: string | description: Numeric price value as string after discount application (e.g., "15.99").
- name: currency | type: string | description: Currency of the value in ISO 4217 format (e.g., "USD", "EUR").
- name: pricingPlanId | type: string | description: Pricing plan GUID.
- name: videoData | type: VideoData | description: Data for a video node.
- name: containerData | type: PluginContainerData | description: Styling for the video's container.
- name: video | type: Media | description: Video details.
- name: thumbnail | type: Media | description: Video thumbnail details.
- name: disableDownload | type: boolean | description: Sets whether the video's download button is disabled. Defaults to `false`.
- name: title | type: string | description: Video title.
- name: options | type: PlaybackOptions | description: Video options.
- name: autoPlay | type: boolean | description: Sets whether the media will automatically start playing.
- name: playInLoop | type: boolean | description: Sets whether media's will be looped.
- name: showControls | type: boolean | description: Sets whether media's controls will be shown.
- name: embedData | type: EmbedData | description: Data for an oEmbed node.
- name: containerData | type: PluginContainerData | description: Styling for the oEmbed node's container.
- name: oembed | type: Oembed | description: An [oEmbed](https://www.oembed.com) object.
- name: type | type: string | description: The resource type.
- name: width | type: integer | description: The width of the resource specified in the `url` property in pixels.
- name: height | type: integer | description: The height of the resource specified in the `url` property in pixels.
- name: title | type: string | description: Resource title.
- name: url | type: string | description: The source URL for the resource.
- name: html | type: string | description: HTML for embedding a video player. The HTML should have no padding or margins.
- name: authorName | type: string | description: The name of the author or owner of the resource.
- name: authorUrl | type: string | description: The URL for the author or owner of the resource.
- name: providerName | type: string | description: The name of the resource provider.
- name: providerUrl | type: string | description: The URL for the resource provider.
- name: thumbnailUrl | type: string | description: The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined.
- name: thumbnailWidth | type: string | description: The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined.
- name: thumbnailHeight | type: string | description: The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined.
- name: videoUrl | type: string | description: The URL for an embedded viedo.
- name: version | type: string | description: The oEmbed version number. This value must be `1.0`.
- name: src | type: string | description: Origin asset source.
- name: collapsibleListData | type: CollapsibleListData | description: Data for a collapsible list node.
- name: containerData | type: PluginContainerData | description: Styling for the collapsible list's container.
- name: expandOnlyOne | type: boolean | description: If `true`, only one item can be expanded at a time. Defaults to `false`.
- name: initialExpandedItems | type: InitialExpandedItems | description: Sets which items are expanded when the page loads.
- enum:
- FIRST: First item will be expended initally
- ALL: All items will expended initally
- NONE: All items collapsed initally
- name: direction | type: Direction | description: The direction of the text in the list. Either left-to-right or right-to-left.
- enum:
- LTR: Left-to-right
- RTL: Right-to-left
- name: isQapageData | type: boolean | description: If `true`, The collapsible item will appear in search results as an FAQ.
- name: tableData | type: TableData | description: Data for a table node.
- name: containerData | type: PluginContainerData | description: Styling for the table's container.
- name: dimensions | type: Dimensions | description: The table's dimensions.
- name: colsWidthRatio | type: array | description: An array representing relative width of each column in relation to the other columns.
- name: rowsHeight | type: array | description: An array representing the height of each row in pixels.
- name: colsMinWidth | type: array | description: An array representing the minimum width of each column in pixels.
- name: rowHeader | type: boolean | description: Sets whether the table's first row is a header. Defaults to `false`.
- name: columnHeader | type: boolean | description: Sets whether the table's first column is a header. Defaults to `false`.
- name: cellSpacing | type: integer | description: The spacing between cells in pixels. Defaults to `0`.
- name: cellPadding | type: array | description: Padding in pixels for cells. Follows CSS order: top, right, bottom, left.
- name: altText | type: string | description: Table's alternative text.
- name: tableCellData | type: TableCellData | description: Data for a table cell node.
- name: cellStyle | type: CellStyle | description: Styling for the cell's background color and text alignment.
- name: verticalAlignment | type: VerticalAlignment | description: Vertical alignment for the cell's text.
- enum:
- TOP: Top alignment
- MIDDLE: Middle alignment
- BOTTOM: Bottom alignment
- name: backgroundColor | type: string | description: Cell background color as a hexadecimal value.
- name: borderColors | type: BorderColors | description: The cell's border colors.
- name: left | type: string | description: Left border color as a hexadecimal value.
- name: right | type: string | description: Right border color as a hexadecimal value.
- name: top | type: string | description: Top border color as a hexadecimal value.
- name: bottom | type: string | description: Bottom border color as a hexadecimal value.
- name: colspan | type: integer | description: Defines how many columns the cell spans. Default: 1.
- name: rowspan | type: integer | description: Defines how many rows the cell spans. Default: 1.
- name: borderWidths | type: BorderWidths | description: The cell's border widths.
- name: left | type: integer | description: Left border width in pixels.
- name: right | type: integer | description: Right border width in pixels.
- name: top | type: integer | description: Top border width in pixels.
- name: bottom | type: integer | description: Bottom border width in pixels.
- name: externalData | type: Struct | description: Data for a custom external node.
- name: fields | type: Map | description: An unordered map of dynamically typed values.
- ONE-OF:
- name: nullValue | type: NullValue | description: A null value.
- enum:
- NULL_VALUE: Null value.
- name: numberValue | type: number | description: A double value.
- name: stringValue | type: string | description: A string value.
- name: boolValue | type: boolean | description: A boolean value.
- name: structValue | type: Struct | description: A structured value.
- name: listValue | type: ListValue | description: An array of `value` objects.
- name: values | type: array | description: Repeated field of dynamically typed values.
- name: audioData | type: AudioData | description: Data for an audio node.
- name: containerData | type: PluginContainerData | description: Styling for the audio node's container.
- name: audio | type: Media | description: Audio file details.
- name: disableDownload | type: boolean | description: Sets whether the audio node's download button is disabled. Defaults to `false`.
- name: coverImage | type: Media | description: Cover image.
- name: name | type: string | description: Track name.
- name: authorName | type: string | description: Author name.
- name: html | type: string | description: An HTML version of the audio node.
- name: orderedListData | type: OrderedListData | description: Data for an ordered list node.
- name: indentation | type: integer | description: Indentation level from 0-4.
- name: offset | type: integer | description: Offset level from 0-4.
- name: start | type: integer | description: List start number.
- name: bulletedListData | type: BulletedListData | description: Data for a bulleted list node.
- name: indentation | type: integer | description: Indentation level from 0-4.
- name: offset | type: integer | description: Offset level from 0-4.
- name: blockquoteData | type: BlockquoteData | description: Data for a block quote node.
- name: indentation | type: integer | description: Indentation level from 1-4.
- name: captionData | type: CaptionData | description: Data for a caption node.
- name: textStyle | type: TextStyle | description:
- name: layoutData | type: LayoutData | description: Data for a layout node. Reserved for future use.
- name: backgroundImage | type: BackgroundImage | description: Background image.
- name: media | type: Media | description: Background image.
- name: opacity | type: integer | description: Background image opacity.
- name: scaling | type: Scaling | description: Background image scaling.
- enum:
- AUTO: Auto image scaling
- CONTAIN: Contain image scaling
- COVER: Cover image scaling
- name: position | type: ImagePosition | description: Position of background. Defaults to `CENTER`.
- enum:
- CENTER: Image positioned at the center
- CENTER_LEFT: Image positioned on the left
- CENTER_RIGHT: Image positioned on the right
- TOP: Image positioned at the center top
- TOP_LEFT: Image positioned at the top left
- TOP_RIGHT: Image positioned at the top right
- BOTTOM: Image positioned at the center bottom
- BOTTOM_LEFT: Image positioned at the bottom left
- BOTTOM_RIGHT: Image positioned at the bottom right
- name: borderColor | type: string | description: Border color as a hexadecimal value.
- name: borderWidth | type: integer | description: Border width in pixels.
- name: borderRadius | type: integer | description: Border radius in pixels.
- name: backdropImage | type: BackgroundImage | description: Backdrop image.
- name: backdropPaddingTop | type: integer | description: Backdrop top padding.
- name: backdropPaddingBottom | type: integer | description: Backdrop bottom padding
- name: gap | type: integer | description: Horizontal and vertical gap between columns
- name: cellPadding | type: array | description: Padding in pixels for cells. Follows CSS order: top, right, bottom, left
- name: cellVerticalAlignment | type: Alignment | description: Vertical alignment for the cell's items.
- enum:
- TOP: Top alignment
- MIDDLE: Middle alignment
- BOTTOM: Bottom alignment
- name: responsivenessBehaviour | type: ResponsivenessBehaviour | description: Responsiveness behaviour of columns when responsiveness applies. Either stacks or wrappers.
- enum:
- STACK: Stacking of columns
- WRAP: Wrapping of columns
- name: responsivenessBreakpoint | type: integer | description: Size in pixels when responsiveness_behaviour applies
- name: containerData | type: PluginContainerData | description: Styling for the layout's container.
- name: designTarget | type: DesignTarget | description: Defines where selected design propertied applies to
- enum:
- LAYOUT: Design applied to layout
- CELL: Design applied to cells
- name: banner | type: Banner | description: Banner configuration. When present, this layout is attached to a document edge (top or bottom).
- name: origin | type: Origin | description: Origin of the banner
- enum:
- IMAGE: Banner originated from an image
- LAYOUT: Banner originated from a layout
- name: position | type: Position | description: Position of the banner
- enum:
- TOP: Attached to the top edge (banner)
- BOTTOM: Attached to the bottom edge (footer)
- name: background | type: Background | description: Background styling (color or gradient).
- name: type | type: Type | description: Background type.
- enum:
- COLOR: Solid color background
- GRADIENT: Gradient background
- name: color | type: string | description: Background color as a hexadecimal value.
- name: gradient | type: Gradient | description: Gradient configuration.
- name: backdrop | type: Backdrop | description: Backdrop styling (color or gradient).
- name: type | type: Type | description: Backdrop type.
- enum:
- COLOR: Solid color backdrop
- GRADIENT: Gradient backdrop
- name: color | type: string | description: Backdrop color as a hexadecimal value.
- name: gradient | type: Gradient | description: Gradient configuration.
- name: layoutCellData | type: LayoutCellData | description: Data for a cell node.
- name: colSpan | type: integer | description: Size of the cell in 12 columns grid.
- name: shapeData | type: ShapeData | description: Data for a shape node.
- name: containerData | type: PluginContainerData | description: Styling for the shape's container.
- name: shape | type: Media | description: Shape file details.
- name: styles | type: Styles | description: Styling for the shape.
- name: color | type: string | description: Shape fill color as a hexadecimal value.
- name: colors | type: object | description: Map of original color keys to their new color values.
- name: cardData | type: CardData | description: Data for a card node.
- name: background | type: Background | description: Background styling (color or gradient).
- name: type | type: Type | description: Background type.
- enum:
- COLOR: Solid color background
- GRADIENT: Gradient background
- name: color | type: string | description: Background color as a hexadecimal value.
- name: gradient | type: Gradient | description: Gradient configuration.
- name: backgroundImage | type: BackgroundImage | description: Background image.
- name: media | type: Media | description: Background image.
- name: opacity | type: integer | description: Background image opacity.
- name: scaling | type: Scaling | description: Background image scaling.
- enum:
- AUTO: Auto image scaling
- CONTAIN: Contain image scaling
- COVER: Cover image scaling
- name: position | type: Position | description: Position of background. Defaults to `CENTER`.
- enum:
- CENTER: Image positioned at the center
- CENTER_LEFT: Image positioned on the left
- CENTER_RIGHT: Image positioned on the right
- TOP: Image positioned at the center top
- TOP_LEFT: Image positioned at the top left
- TOP_RIGHT: Image positioned at the top right
- BOTTOM: Image positioned at the center bottom
- BOTTOM_LEFT: Image positioned at the bottom left
- BOTTOM_RIGHT: Image positioned at the bottom right
- name: tocData | type: TocData | description: Data for a table of contents node.
- name: includedHeadings | type: array | description: Heading levels included in the table of contents. Default: [1, 2, 3, 4, 5, 6].
- name: listStyle | type: ListStyle | description: List style. Default: PLAIN.
- enum:
- PLAIN: No markers (default)
- NUMBERED: Numbered list
- LETTERS: Alphabetic letters
- ROMAN: Roman numerals
- BULLETED: Bulleted list
- ALPHABETICAL_INDEX: Alphabetical index
- ALPHABETICAL_INDEX_COMPACT: Alphabetical index (compact top-row only)
- name: fontSize | type: number | description: Optional override for the font size in pixels.
- name: itemSpacing | type: number | description: Optional override for the vertical spacing between items in pixels.
- name: color | type: string | description: Optional override for the text color.
- name: indentation | type: Indentation | description: Indentation style. Default: NESTED.
- enum:
- NESTED: Sub-headings indented under parents (default)
- FLAT: All items at the same level
- name: smartBlockData | type: SmartBlockData | description: Data for a smart block node.
- name: type | type: Type | description: The type of the smart block.
- enum:
- SOLID_BOXES: Grid-based layouts with solid box items containing title, body, and icon/image.
- NUMBERED_BOXES: Numbered boxes.
- STATS: Statistics display with large numbers/values.
- CIRCLE_STATS: Statistics with circular visual elements.
- SOLID_BOXES_ALTERNATING: Staggered/zigzag grid layout with alternating box positions.
- SOLID_JOINED_BOXES: Grid layout with boxes visually joined (no gaps, shared container border).
- SIDE_LINE_TEXT: Transparent cells with only a left side line.
- TOP_LINE_TEXT: Transparent cells with only a top line.
- OUTLINE_BOXES_WITH_TOP_CIRCLE: Outlined boxes with a numbered/icon circle at the top.
- BIG_BULLETS: Large icon bullets with text content.
- SMALL_BULLETS: Small dot bullets with text content.
- ARROW_BULLETS: Arrow icon bullets with text content.
- PROCESS_STEPS: Process steps with numbered/icon labels above a horizontal line.
- BAR_STATS: Statistics with bar visual elements.
- TIMELINE: Timeline layout with numbered chips on a connecting line; cells alternate around the line.
- MINIMAL_TIMELINE: Timeline layout with plain dot indicators; no numbers or shapes; cells alternate around the line.
- PILLS: Numbered pill-shaped labels (stadium chips) with text content; supports HORIZONTAL (pill on top) and VERTICAL (pill on left) orientations.
- STAR_RATING: Star rating display with stars and a numeric value per cell.
- QUOTE_BOXES: Outlined boxes with decorative quote glyphs at the top-left and bottom-right corners.
- name: orientation | type: string | description: Layout orientation. HORIZONTAL or VERTICAL. Optional for variants with fixed orientation.
- name: columnSize | type: ColumnSize | description: Column size controlling cells per row.
- enum:
- SMALL: Up to 4 cells in a row.
- MEDIUM: Up to 3 cells in a row (default).
- LARGE: Up to 2 cells in a row.
- EXTRA_LARGE: 1 cell in a row.
- name: borderColor | type: string | description: Border color (for SOLID_JOINED_BOXES variant).
- name: borderWidth | type: integer | description: Border width in pixels (for SOLID_JOINED_BOXES variant).
- name: borderRadius | type: integer | description: Border radius in pixels (for SOLID_JOINED_BOXES variant).
- name: smartBlockCellData | type: SmartBlockCellData | description: Data for a smart block cell node.
- name: label | type: string | description: Optional label text for the cell (e.g., for stats variants).
- name: shape | type: Media | description: Shape file details.
- name: borderColor | type: string | description: Border color of the cell.
- name: borderWidth | type: integer | description: Border width in pixels.
- name: borderRadius | type: integer | description: Border radius in pixels.
- name: type | type: Type | description: The type of the parent smart block (must match parent).
- name: accentColor | type: string | description: Accent color for non-background variants (e.g., line, bullet, label color).
- name: backgroundColor | type: string | description: Background color for background-based variants (SOLID_BOXES, SOLID_BOXES_ALTERNATING, SOLID_JOINED_BOXES).
- name: shapeColor | type: string | description: Shape fill color as a hexadecimal value.
- name: type | type: Type | description: Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format.
- enum: PARAGRAPH, TEXT, HEADING, BULLETED_LIST, ORDERED_LIST, LIST_ITEM, BLOCKQUOTE, CODE_BLOCK, VIDEO, DIVIDER, FILE, GALLERY, GIF, HTML, IMAGE, LINK_PREVIEW, MAP, POLL, APP_EMBED, BUTTON, COLLAPSIBLE_LIST, TABLE, EMBED, COLLAPSIBLE_ITEM, COLLAPSIBLE_ITEM_TITLE, COLLAPSIBLE_ITEM_BODY, TABLE_CELL, TABLE_ROW, EXTERNAL, AUDIO, CAPTION, LAYOUT, LAYOUT_CELL, SHAPE, CARD, TOC, SMART_BLOCK, SMART_BLOCK_CELL
- name: id | type: string | description: Node GUID.
- name: nodes | type: array | description: A list of child nodes.
- name: style | type: NodeStyle | description: Padding and background color styling for the node.
- name: paddingTop | type: string | description: The top padding value in pixels.
- name: paddingBottom | type: string | description: The bottom padding value in pixels.
- name: backgroundColor | type: string | description: The background color as a hexadecimal value.
- name: metadata | type: Metadata | description: Object metadata.
- name: version | type: integer | description: Schema version.
- name: id | type: string | description: Object GUID.
- name: documentStyle | type: DocumentStyle | description: Global styling for header, paragraph, block quote, and code block nodes in the object.
- name: headerOne | type: TextNodeStyle | description: Styling for H1 nodes.
- name: decorations | type: array | description: The decorations to apply to the node.
- name: nodeStyle | type: NodeStyle | description: Padding and background color for the node.
- name: lineHeight | type: string | description: Line height for text in the node.
- name: headerTwo | type: TextNodeStyle | description: Styling for H2 nodes.
- name: headerThree | type: TextNodeStyle | description: Styling for H3 nodes.
- name: headerFour | type: TextNodeStyle | description: Styling for H4 nodes.
- name: headerFive | type: TextNodeStyle | description: Styling for H5 nodes.
- name: headerSix | type: TextNodeStyle | description: Styling for H6 nodes.
- name: paragraph | type: TextNodeStyle | description: Styling for paragraph nodes.
- name: blockquote | type: TextNodeStyle | description: Styling for block quote nodes.
- name: codeBlock | type: TextNodeStyle | description: Styling for code block nodes.
```
### Examples
### Get the Member "About" Section Content
```curl
curl -X GET \
https://www.wixapis.com/members/v2/abouts/e901b292-70f0-4a20-8aaf-e06cd5dc5ca2 \
-H 'Authorization: '
```
---
## JavaScript SDK
### Schema
```
Method: wixClientAdmin.memberManagement.MembersAbout.getMemberAbout(_id)
Description: Retrieves a member's "About" section content.
# Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
Required parameters: _id
Method parameters:
param name: _id | type: string | description: GUID of the "About" section content to retrieve. | required: true
Return type: PROMISE
- name: _id | type: string | description: GUID of the "About" section content.
- name: revision | type: string | description: Revision number, which increments by 1 each time the "About" section content is updated. To prevent conflicting changes, the existing revision must be used when updating an "About" section content.
- name: memberId | type: string | description: Member GUID.
- name: content | type: RichContent | description: Fallback Message for SSR and Error .
- name: nodes | type: array | description: Node objects representing a rich content document.
- ONE-OF:
- name: buttonData | type: ButtonData | description: Data for a button node.
- name: containerData | type: PluginContainerData | description: Styling for the button's container.
- name: width | type: Width | description: The width of the node when it's displayed.
- ONE-OF:
- name: size | type: Type | description: One of the following predefined width options: `CONTENT`: The width of the container matches the content width. `SMALL`: A small width. `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width. `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
- enum:
- CONTENT: Width matches the content width
- SMALL: Small Width
- ORIGINAL: Width will match the original asset width
- FULL_WIDTH: coast-to-coast display
- name: custom | type: string | description: A custom width value in pixels.
- name: alignment | type: Alignment | description: The node's alignment within its container.
- enum:
- CENTER: Center Alignment
- LEFT: Left Alignment
- RIGHT: Right Alignment
- name: spoiler | type: Spoiler | description: Spoiler cover settings for the node.
- name: enabled | type: boolean | description: Sets whether the spoiler cover is enabled for this node. Defaults to `false`.
- name: description | type: string | description: The description displayed on top of the spoiler cover.
- name: buttonText | type: string | description: The text for the button used to remove the spoiler cover.
- name: height | type: Height | description: The height of the node when it's displayed.
- name: custom | type: string | description: A custom height value in pixels.
- name: textWrap | type: boolean | description: Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`.
- name: type | type: Type | description: The button type.
- enum:
- LINK: Regular link button
- ACTION: Triggers custom action that is defined in plugin configuration by the consumer
- name: styles | type: Styles | description: Styling for the button.
- name: borderWidth | type: integer | description: Border width in pixels.
- name: borderRadius | type: integer | description: Border radius in pixels.
- name: borderColor | type: string | description: Border color as a hexadecimal value.
- name: borderColorHover | type: string | description: Border color as a hexadecimal value (hover state).
- name: textColor | type: string | description: Text color as a hexadecimal value.
- name: textColorHover | type: string | description: Text color as a hexadecimal value (hover state).
- name: buttonSize | type: string | description: Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`.
- name: background | type: Background | description: Background styling (color or gradient).
- name: type | type: Type | description: Background type.
- enum:
- COLOR: Solid color background
- GRADIENT: Gradient background
- name: color | type: string | description: Background color as a hexadecimal value.
- name: gradient | type: Gradient | description: Gradient configuration.
- name: type | type: Type | description: Gradient type.
- enum:
- LINEAR: Linear gradient.
- RADIAL: Radial gradient.
- name: stops | type: array | description: Color stops for the gradient.
- name: color | type: string | description: Stop color as hex value.
- name: position | type: number | description: Stop position (0-1).
- name: angle | type: integer | description: Angle in degrees for linear gradient (0-360).
- name: centerX | type: number | description: Horizontal center position for radial gradient (0-100).
- name: centerY | type: number | description: Vertical center position for radial gradient (0-100).
- name: backgroundHover | type: Background | description: Background styling for hover state (color or gradient).
- name: text | type: string | description: The text to display on the button.
- name: link | type: Link | description: Button link details.
- ONE-OF:
- name: url | type: string | description: The absolute URL for the linked document.
- name: anchor | type: string | description: The target node's GUID. Used for linking to another node in this object.
- name: target | type: Target | description: he HTML `target` attribute value for the link. This property defines where the linked document opens as follows: `SELF` - Default. Opens the linked document in the same frame as the link. `BLANK` - Opens the linked document in a new browser tab or window. `PARENT` - Opens the linked document in the link's parent frame. `TOP` - Opens the linked document in the full body of the link's browser tab or window.
- enum:
- SELF: Opens the linked document in the same frame as it was clicked (this is default)
- BLANK: Opens the linked document in a new window or tab
- PARENT: Opens the linked document in the parent frame
- TOP: Opens the linked document in the full body of the window
- name: rel | type: Rel | description: The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document.
- name: nofollow | type: boolean | description: Indicates to search engine crawlers not to follow the link. Defaults to `false`.
- name: sponsored | type: boolean | description: Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`.
- name: ugc | type: boolean | description: Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`.
- name: noreferrer | type: boolean | description: Indicates that this link protect referral information from being passed to the target website.
- name: customData | type: string | description: A serialized object used for a custom or external link panel.
- name: codeBlockData | type: CodeBlockData | description: Data for a code block node.
- name: textStyle | type: TextStyle | description: Styling for the code block's text.
- name: textAlignment | type: TextAlignment | description: Text alignment. Defaults to `AUTO`.
- enum:
- AUTO: browser default, eqivalent to `initial`
- LEFT: Left align
- RIGHT: Right align
- CENTER: Center align
- JUSTIFY: Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line
- name: lineHeight | type: string | description: A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px.
- name: dividerData | type: DividerData | description: Data for a divider node.
- name: containerData | type: PluginContainerData | description: Styling for the divider's container.
- name: lineStyle | type: LineStyle | description: Divider line style.
- enum:
- SINGLE: Single Line
- DOUBLE: Double Line
- DASHED: Dashed Line
- DOTTED: Dotted Line
- name: width | type: Width | description: Divider width.
- enum:
- LARGE: Large line
- MEDIUM: Medium line
- SMALL: Small line
- name: alignment | type: Alignment | description: Divider alignment.
- enum:
- CENTER: Center alignment
- LEFT: Left alignment
- RIGHT: Right alignment
- name: fileData | type: FileData | description: Data for a file node.
- name: containerData | type: PluginContainerData | description: Styling for the file's container.
- name: src | type: FileSource | description: The source for the file's data.
- ONE-OF:
- name: url | type: string | description: The absolute URL for the file's source.
- name: _id | type: string | description: An GUID that's resolved to a URL by a resolver function.
- name: private | type: boolean | description: Indicates whether the file's source is private. Defaults to `false`.
- name: name | type: string | description: File name.
- name: type | type: string | description: File type.
- name: pdfSettings | type: PDFSettings | description: Settings for PDF files.
- name: viewMode | type: ViewMode | description: PDF view mode. One of the following: `NONE` : The PDF isn't displayed. `FULL` : A full page view of the PDF is displayed. `MINI` : A mini view of the PDF is displayed.
- enum:
- NONE: No PDF view
- FULL: Full PDF view
- MINI: Mini PDF view
- name: disableDownload | type: boolean | description: Sets whether the PDF download button is disabled. Defaults to `false`.
- name: disablePrint | type: boolean | description: Sets whether the PDF print button is disabled. Defaults to `false`.
- name: mimeType | type: string | description: File MIME type.
- name: path | type: string | description: File path.
- name: sizeInKb | type: string | description: File size in KB.
- name: galleryData | type: GalleryData | description: Data for a gallery node.
- name: containerData | type: PluginContainerData | description: Styling for the gallery's container.
- name: items | type: array- | description: The items in the gallery.
- ONE-OF:
- name: image | type: Image | description: An image item.
- name: media | type: Media | description: Image file details.
- name: src | type: FileSource | description: The source for the media's data.
- name: width | type: integer | description: Media width in pixels.
- name: height | type: integer | description: Media height in pixels.
- name: duration | type: number | description: Media duration in seconds. Only relevant for audio and video files.
- name: link | type: Link | description: Link details for images that are links.
- name: video | type: Video | description: A video item.
- name: media | type: Media | description: Video file details.
- name: thumbnail | type: Media | description: Video thumbnail file details.
- name: title | type: string | description: Item title.
- name: altText | type: string | description: Item's alternative text.
- name: options | type: GalleryOptions | description: Options for defining the gallery's appearance.
- name: layout | type: Layout | description: Gallery layout.
- name: type | type: Type | description: Gallery layout type.
- enum:
- COLLAGE: Collage type
- MASONRY: Masonry type
- GRID: Grid type
- THUMBNAIL: Thumbnail type
- SLIDER: Slider type
- SLIDESHOW: Slideshow type
- PANORAMA: Panorama type
- COLUMN: Column type
- MAGIC: Magic type
- FULLSIZE: Fullsize images type
- name: horizontalScroll | type: boolean | description: Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`.
- name: orientation | type: Orientation | description: Gallery orientation.
- enum:
- ROWS: Rows Orientation
- COLUMNS: Columns Orientation
- name: numberOfColumns | type: integer | description: The number of columns to display on full size screens.
- name: mobileNumberOfColumns | type: integer | description: The number of columns to display on mobile screens.
- name: item | type: ItemStyle | description: Styling for gallery items.
- name: targetSize | type: integer | description: Desirable dimension for each item in pixels (behvaior changes according to gallery type)
- name: ratio | type: number | description: Item ratio
- name: crop | type: Crop | description: Sets how item images are cropped.
- enum:
- FILL: Crop to fill
- FIT: Crop to fit
- name: spacing | type: integer | description: The spacing between items in pixels.
- name: thumbnails | type: Thumbnails | description: Styling for gallery thumbnail images.
- name: placement | type: Alignment | description: Thumbnail alignment.
- enum:
- TOP: Top alignment
- RIGHT: Right alignment
- BOTTOM: Bottom alignment
- LEFT: Left alignment
- NONE: No thumbnail
- name: spacing | type: integer | description: Spacing between thumbnails in pixels.
- name: disableExpand | type: boolean | description: Sets whether the gallery's expand button is disabled. Defaults to `false`.
- name: disableDownload | type: boolean | description: Sets whether the gallery's download button is disabled. Defaults to `false`.
- name: gifData | type: GIFData | description: Data for a GIF node.
- name: containerData | type: PluginContainerData | description: Styling for the GIF's container.
- name: original | type: GIF | description: The source of the full size GIF.
- name: gif | type: string | description: GIF format URL.
- name: mp4 | type: string | description: MP4 format URL.
- name: still | type: string | description: Thumbnail URL.
- name: downsized | type: GIF | description: The source of the downsized GIF.
- name: height | type: integer | description: Height in pixels.
- name: width | type: integer | description: Width in pixels.
- name: gifType | type: GIFType | description: Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`.
- enum: NORMAL, STICKER
- name: headingData | type: HeadingData | description: Data for a heading node.
- name: level | type: integer | description: Heading level from 1-6.
- name: textStyle | type: TextStyle | description: Styling for the heading text.
- name: indentation | type: integer | description: Indentation level from 1-4.
- name: renderedLevel | type: integer | description: Rendered heading level for SEO/accessibility, overrides the HTML tag when set.
- name: htmlData | type: HTMLData | description: Data for an embedded HTML node.
- ONE-OF:
- name: url | type: string | description: The URL for the HTML code for the node.
- name: html | type: string | description: The HTML code for the node.
- name: widgetId | type: string | description: The WixelWidget GUID for AI_WIDGET source nodes.
- name: containerData | type: PluginContainerData | description: Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`.
- name: source | type: Source | description: The type of HTML code.
- enum: HTML, ADSENSE, AI, AI_WIDGET
- name: autoHeight | type: boolean | description: If container height is aligned with its content height. Defaults to `true`.
- name: imageData | type: ImageData | description: Data for an image node.
- name: containerData | type: PluginContainerData | description: Styling for the image's container.
- name: image | type: Media | description: Image file details.
- name: link | type: Link | description: Link details for images that are links.
- name: disableExpand | type: boolean | description: Sets whether the image expands to full screen when clicked. Defaults to `false`.
- name: altText | type: string | description: Image's alternative text.
- name: disableDownload | type: boolean | description: Sets whether the image's download button is disabled. Defaults to `false`.
- name: decorative | type: boolean | description: Sets whether the image is decorative and does not need an explanation. Defaults to `false`.
- name: styles | type: Styles | description: Styling for the image.
- name: border | type: Border | description: Border attributes.
- name: width | type: integer | description: Border width in pixels.
- name: color | type: string | description: Border color as a hexadecimal value.
- name: radius | type: integer | description: Border radius in pixels.
- name: linkPreviewData | type: LinkPreviewData | description: Data for a link preview node.
- name: containerData | type: PluginContainerData | description: Styling for the link preview's container.
- name: link | type: Link | description: Link details.
- name: title | type: string | description: Preview title.
- name: thumbnailUrl | type: string | description: Preview thumbnail URL.
- name: description | type: string | description: Preview description.
- name: html | type: string | description: The preview content as HTML.
- name: styles | type: Styles | description: Styling for the link preview.
- name: backgroundColor | type: string | description: Background color as a hexadecimal value.
- name: titleColor | type: string | description: Title color as a hexadecimal value.
- name: subtitleColor | type: string | description: Subtitle color as a hexadecimal value.
- name: linkColor | type: string | description: Link color as a hexadecimal value.
- name: borderWidth | type: integer | description: Border width in pixels.
- name: borderRadius | type: integer | description: Border radius in pixels.
- name: borderColor | type: string | description: Border color as a hexadecimal value.
- name: thumbnailPosition | type: Position | description: Position of thumbnail. Defaults to `START`.
- enum:
- START: Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts)
- END: Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts)
- TOP: Thumbnail positioned at the top
- HIDDEN: Thumbnail hidden and not displayed
- name: paragraphData | type: ParagraphData | description: Data for a paragraph node.
- name: textStyle | type: TextStyle | description: Styling for the paragraph text.
- name: indentation | type: integer | description: Indentation level from 1-4.
- name: level | type: integer | description: Paragraph level
- name: pollData | type: PollData | description: Data for a poll node.
- name: containerData | type: PluginContainerData | description: Styling for the poll's container.
- name: poll | type: Poll | description: Poll data.
- name: _id | type: string | description: Poll GUID.
- name: title | type: string | description: Poll title.
- name: creatorId | type: string | description: Poll creator GUID.
- name: image | type: Media | description: Main poll image.
- name: options | type: array
| description: Voting options.
- name: _id | type: string | description: Option GUID.
- name: title | type: string | description: Option title.
- name: image | type: Media | description: The image displayed with the option.
- name: settings | type: Settings | description: The poll's permissions and display settings.
- name: permissions | type: Permissions | description: Permissions settings for voting.
- name: view | type: ViewRole | description: Sets who can view the poll results.
- enum:
- CREATOR: Only Poll creator can view the results
- VOTERS: Anyone who voted can see the results
- EVERYONE: Anyone can see the results, even if one didn't vote
- name: vote | type: VoteRole | description: Sets who can vote.
- enum:
- SITE_MEMBERS: Logged in member
- ALL: Anyone
- name: allowMultipleVotes | type: boolean | description: Sets whether one voter can vote multiple times. Defaults to `false`.
- name: showVoters | type: boolean | description: Sets whether voters are displayed in the vote results. Defaults to `true`.
- name: showVotesCount | type: boolean | description: Sets whether the vote count is displayed. Defaults to `true`.
- name: layout | type: Layout | description: Layout settings for the poll and voting options.
- name: poll | type: PollLayout | description: Poll layout settings.
- name: type | type: Type | description: The layout for displaying the voting options.
- enum:
- LIST: List
- GRID: Grid
- name: direction | type: Direction | description: The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right.
- enum:
- LTR: Left-to-right
- RTL: Right-to-left
- name: enableImage | type: boolean | description: Sets whether to display the main poll image. Defaults to `false`.
- name: options | type: OptionLayout | description: Voting otpions layout settings.
- name: enableImage | type: boolean | description: Sets whether to display option images. Defaults to `false`.
- name: design | type: Design | description: Styling for the poll and voting options.
- name: poll | type: PollDesign | description: Styling for the poll.
- name: background | type: Background | description: Background styling.
- ONE-OF:
- name: color | type: string | description: The background color as a hexademical value.
- name: image | type: Media | description: An image to use for the background.
- name: gradient | type: Gradient | description: Details for a gradient background.
- name: angle | type: integer | description: The gradient angle in degrees.
- name: startColor | type: string | description: The start color as a hexademical value.
- name: lastColor | type: string | description: The end color as a hexademical value.
- name: type | type: Type | description: Background type. For each option, include the relevant details.
- enum:
- COLOR: Color background type
- IMAGE: Image background type
- GRADIENT: Gradiant background type
- name: borderRadius | type: integer | description: Border radius in pixels.
- name: options | type: OptionDesign | description: Styling for voting options.
- name: borderRadius | type: integer | description: Border radius in pixels.
- name: textData | type: TextData | description: Data for a text node. Used to apply decorations to text.
- name: text | type: string | description: The text to apply decorations to.
- name: decorations | type: array | description: The decorations to apply.
- ONE-OF:
- name: anchorData | type: AnchorData | description: Data for an anchor link decoration.
- name: anchor | type: string | description: The target node's GUID.
- name: colorData | type: ColorData | description: Data for a color decoration.
- name: background | type: string | description: The text's background color as a hexadecimal value.
- name: foreground | type: string | description: The text's foreground color as a hexadecimal value.
- name: linkData | type: LinkData | description: Data for an external link decoration.
- name: link | type: Link | description: Link details.
- name: mentionData | type: MentionData | description: Data for a mention decoration.
- name: name | type: string | description: The mentioned user's name.
- name: slug | type: string | description: The version of the user's name that appears after the `@` character in the mention.
- name: _id | type: string | description: Mentioned user's GUID.
- name: fontSizeData | type: FontSizeData | description: Data for a font size decoration.
- name: unit | type: fontType | description: The units used for the font size.
- enum: PX, EM
- name: value | type: integer | description: Font size value.
- name: fontWeightValue | type: integer | description: Font weight for a bold decoration.
- name: italicData | type: boolean | description: Data for an italic decoration. Defaults to `true`.
- name: underlineData | type: boolean | description: Data for an underline decoration. Defaults to `true`.
- name: spoilerData | type: SpoilerData | description: Data for a spoiler decoration.
- name: _id | type: string | description: Spoiler GUID.
- name: strikethroughData | type: boolean | description: Data for a strikethrough decoration. Defaults to `true`.
- name: superscriptData | type: boolean | description: Data for a superscript decoration. Defaults to `true`.
- name: subscriptData | type: boolean | description: Data for a subscript decoration. Defaults to `true`.
- name: fontFamilyData | type: FontFamilyData | description: Data for a font family decoration.
- name: value | type: string | description:
- name: type | type: Type | description: The type of decoration to apply.
- enum: BOLD, ITALIC, UNDERLINE, SPOILER, ANCHOR, MENTION, LINK, COLOR, FONT_SIZE, EXTERNAL, STRIKETHROUGH, SUPERSCRIPT, SUBSCRIPT, FONT_FAMILY
- name: appEmbedData | type: AppEmbedData | description: Data for an app embed node.
- ONE-OF:
- name: bookingData | type: BookingData | description: Data for embedded Wix Bookings content.
- name: durations | type: string | description: Booking duration in minutes.
- name: eventData | type: EventData | description: Data for embedded Wix Events content.
- name: scheduling | type: string | description: Event schedule.
- name: location | type: string | description: Event location.
- name: type | type: AppType | description: The type of Wix App content being embedded.
- enum: PRODUCT, EVENT, BOOKING
- name: itemId | type: string | description: The GUID of the embedded content.
- name: name | type: string | description: The name of the embedded content.
- name: url | type: string | description: The URL for the embedded content.
- name: image | type: Media | description: An image for the embedded content.
- name: hideImage | type: boolean | description: Whether to hide the image.
- name: hideTitle | type: boolean | description: Whether to hide the title.
- name: hidePrice | type: boolean | description: Whether to hide the price.
- name: hideDescription | type: boolean | description: Whether to hide the description (Event and Booking).
- name: hideDateTime | type: boolean | description: Whether to hide the date and time (Event).
- name: hideLocation | type: boolean | description: Whether to hide the location (Event).
- name: hideDuration | type: boolean | description: Whether to hide the duration (Booking).
- name: hideButton | type: boolean | description: Whether to hide the button.
- name: hideRibbon | type: boolean | description: Whether to hide the ribbon.
- name: buttonStyles | type: ButtonStyles | description: Button styling options.
- name: buttonText | type: string | description: Text to display on the button.
- name: borderWidth | type: integer | description: Border width in pixels.
- name: borderRadius | type: integer | description: Border radius in pixels.
- name: borderColor | type: string | description: Border color as a hexadecimal value.
- name: textColor | type: string | description: Text color as a hexadecimal value.
- name: backgroundColor | type: string | description: Background color as a hexadecimal value.
- name: borderColorHover | type: string | description: Border color as a hexadecimal value (hover state).
- name: textColorHover | type: string | description: Text color as a hexadecimal value (hover state).
- name: backgroundColorHover | type: string | description: Background color as a hexadecimal value (hover state).
- name: buttonSize | type: string | description: Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`.
- name: imageStyles | type: ImageStyles | description: Image styling options.
- name: hideImage | type: boolean | description: Whether to hide the image.
- name: imagePosition | type: Position | description: Position of image. Defaults to `START`.
- enum:
- START: Image positioned at the start (left in LTR layouts, right in RTL layouts)
- END: Image positioned at the end (right in LTR layouts, left in RTL layouts)
- TOP: Image positioned at the top
- name: aspectRatio | type: AspectRatio | description: Aspect ratio for the image. Defaults to `SQUARE`.
- enum:
- SQUARE: 1:1 aspect ratio
- RECTANGLE: 16:9 aspect ratio
- name: resizing | type: Resizing | description: How the image should be resized. Defaults to `FILL`.
- enum:
- FILL: Fill the container, may crop the image
- FIT: Fit the image within the container
- name: borderColor | type: string | description: Image border color as a hexadecimal value.
- name: borderWidth | type: integer | description: Image border width in pixels.
- name: borderRadius | type: integer | description: Image border radius in pixels.
- name: ribbonStyles | type: RibbonStyles | description: Ribbon styling options.
- name: ribbonText | type: string | description: Text to display on the ribbon.
- name: backgroundColor | type: string | description: Ribbon background color as a hexadecimal value.
- name: textColor | type: string | description: Ribbon text color as a hexadecimal value.
- name: borderColor | type: string | description: Ribbon border color as a hexadecimal value.
- name: borderWidth | type: integer | description: Ribbon border width in pixels.
- name: borderRadius | type: integer | description: Ribbon border radius in pixels.
- name: ribbonPlacement | type: Placement | description: Placement of the ribbon. Defaults to `IMAGE`.
- enum:
- IMAGE: Ribbon placed on the image
- PRODUCT_INFO: Ribbon placed on the product information
- name: cardStyles | type: CardStyles | description: Card styling options.
- name: backgroundColor | type: string | description: Card background color as a hexadecimal value.
- name: borderColor | type: string | description: Card border color as a hexadecimal value.
- name: borderWidth | type: integer | description: Card border width in pixels.
- name: borderRadius | type: integer | description: Card border radius in pixels.
- name: type | type: Type | description: Card type. Defaults to `CONTAINED`.
- enum:
- CONTAINED: Card with visible border and background
- FRAMELESS: Card without visible border
- name: alignment | type: Alignment | description: Content alignment. Defaults to `START`.
- enum:
- START: Content aligned to start (left in LTR layouts, right in RTL layouts)
- CENTER: Content centered
- END: Content aligned to end (right in LTR layouts, left in RTL layouts)
- name: titlePriceLayout | type: Layout | description: Layout for title and price. Defaults to `STACKED`.
- enum:
- STACKED: Elements stacked vertically
- SIDE_BY_SIDE: Elements arranged horizontally
- name: titleColor | type: string | description: Title text color as a hexadecimal value.
- name: textColor | type: string | description: Text color as a hexadecimal value.
- name: containerData | type: PluginContainerData | description: Styling for the app embed's container.
- name: pricingData | type: PricingData | description: Pricing data for embedded Wix App content.
- name: valueFrom | type: string | description: Minimum numeric price value as string (e.g., "10.99").
- name: valueTo | type: string | description: Maximum numeric price value as string (e.g., "19.99").
- name: discountedValue | type: string | description: Numeric price value as string after discount application (e.g., "15.99").
- name: currency | type: string | description: Currency of the value in ISO 4217 format (e.g., "USD", "EUR").
- name: pricingPlanId | type: string | description: Pricing plan GUID.
- name: videoData | type: VideoData | description: Data for a video node.
- name: containerData | type: PluginContainerData | description: Styling for the video's container.
- name: video | type: Media | description: Video details.
- name: thumbnail | type: Media | description: Video thumbnail details.
- name: disableDownload | type: boolean | description: Sets whether the video's download button is disabled. Defaults to `false`.
- name: title | type: string | description: Video title.
- name: options | type: PlaybackOptions | description: Video options.
- name: autoPlay | type: boolean | description: Sets whether the media will automatically start playing.
- name: playInLoop | type: boolean | description: Sets whether media's will be looped.
- name: showControls | type: boolean | description: Sets whether media's controls will be shown.
- name: embedData | type: EmbedData | description: Data for an oEmbed node.
- name: containerData | type: PluginContainerData | description: Styling for the oEmbed node's container.
- name: oembed | type: Oembed | description: An [oEmbed](https://www.oembed.com) object.
- name: type | type: string | description: The resource type.
- name: width | type: integer | description: The width of the resource specified in the `url` property in pixels.
- name: height | type: integer | description: The height of the resource specified in the `url` property in pixels.
- name: title | type: string | description: Resource title.
- name: url | type: string | description: The source URL for the resource.
- name: html | type: string | description: HTML for embedding a video player. The HTML should have no padding or margins.
- name: authorName | type: string | description: The name of the author or owner of the resource.
- name: authorUrl | type: string | description: The URL for the author or owner of the resource.
- name: providerName | type: string | description: The name of the resource provider.
- name: providerUrl | type: string | description: The URL for the resource provider.
- name: thumbnailUrl | type: string | description: The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined.
- name: thumbnailWidth | type: string | description: The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined.
- name: thumbnailHeight | type: string | description: The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined.
- name: videoUrl | type: string | description: The URL for an embedded viedo.
- name: version | type: string | description: The oEmbed version number. This value must be `1.0`.
- name: src | type: string | description: Origin asset source.
- name: collapsibleListData | type: CollapsibleListData | description: Data for a collapsible list node.
- name: containerData | type: PluginContainerData | description: Styling for the collapsible list's container.
- name: expandOnlyOne | type: boolean | description: If `true`, only one item can be expanded at a time. Defaults to `false`.
- name: initialExpandedItems | type: InitialExpandedItems | description: Sets which items are expanded when the page loads.
- enum:
- FIRST: First item will be expended initally
- ALL: All items will expended initally
- NONE: All items collapsed initally
- name: direction | type: Direction | description: The direction of the text in the list. Either left-to-right or right-to-left.
- enum:
- LTR: Left-to-right
- RTL: Right-to-left
- name: isQapageData | type: boolean | description: If `true`, The collapsible item will appear in search results as an FAQ.
- name: tableData | type: TableData | description: Data for a table node.
- name: containerData | type: PluginContainerData | description: Styling for the table's container.
- name: dimensions | type: Dimensions | description: The table's dimensions.
- name: colsWidthRatio | type: array | description: An array representing relative width of each column in relation to the other columns.
- name: rowsHeight | type: array | description: An array representing the height of each row in pixels.
- name: colsMinWidth | type: array | description: An array representing the minimum width of each column in pixels.
- name: rowHeader | type: boolean | description: Sets whether the table's first row is a header. Defaults to `false`.
- name: columnHeader | type: boolean | description: Sets whether the table's first column is a header. Defaults to `false`.
- name: cellSpacing | type: integer | description: The spacing between cells in pixels. Defaults to `0`.
- name: cellPadding | type: array | description: Padding in pixels for cells. Follows CSS order: top, right, bottom, left.
- name: altText | type: string | description: Table's alternative text.
- name: tableCellData | type: TableCellData | description: Data for a table cell node.
- name: cellStyle | type: CellStyle | description: Styling for the cell's background color and text alignment.
- name: verticalAlignment | type: VerticalAlignment | description: Vertical alignment for the cell's text.
- enum:
- TOP: Top alignment
- MIDDLE: Middle alignment
- BOTTOM: Bottom alignment
- name: backgroundColor | type: string | description: Cell background color as a hexadecimal value.
- name: borderColors | type: BorderColors | description: The cell's border colors.
- name: left | type: string | description: Left border color as a hexadecimal value.
- name: right | type: string | description: Right border color as a hexadecimal value.
- name: top | type: string | description: Top border color as a hexadecimal value.
- name: bottom | type: string | description: Bottom border color as a hexadecimal value.
- name: colspan | type: integer | description: Defines how many columns the cell spans. Default: 1.
- name: rowspan | type: integer | description: Defines how many rows the cell spans. Default: 1.
- name: borderWidths | type: BorderWidths | description: The cell's border widths.
- name: left | type: integer | description: Left border width in pixels.
- name: right | type: integer | description: Right border width in pixels.
- name: top | type: integer | description: Top border width in pixels.
- name: bottom | type: integer | description: Bottom border width in pixels.
- name: externalData | type: Struct | description: Data for a custom external node.
- name: fields | type: Map | description: An unordered map of dynamically typed values.
- ONE-OF:
- name: nullValue | type: NullValue | description: A null value.
- enum:
- NULL_VALUE: Null value.
- name: numberValue | type: number | description: A double value.
- name: stringValue | type: string | description: A string value.
- name: boolValue | type: boolean | description: A boolean value.
- name: structValue | type: Struct | description: A structured value.
- name: listValue | type: ListValue | description: An array of `value` objects.
- name: values | type: array | description: Repeated field of dynamically typed values.
- name: audioData | type: AudioData | description: Data for an audio node.
- name: containerData | type: PluginContainerData | description: Styling for the audio node's container.
- name: audio | type: Media | description: Audio file details.
- name: disableDownload | type: boolean | description: Sets whether the audio node's download button is disabled. Defaults to `false`.
- name: coverImage | type: Media | description: Cover image.
- name: name | type: string | description: Track name.
- name: authorName | type: string | description: Author name.
- name: html | type: string | description: An HTML version of the audio node.
- name: orderedListData | type: OrderedListData | description: Data for an ordered list node.
- name: indentation | type: integer | description: Indentation level from 0-4.
- name: offset | type: integer | description: Offset level from 0-4.
- name: start | type: integer | description: List start number.
- name: bulletedListData | type: BulletedListData | description: Data for a bulleted list node.
- name: indentation | type: integer | description: Indentation level from 0-4.
- name: offset | type: integer | description: Offset level from 0-4.
- name: blockquoteData | type: BlockquoteData | description: Data for a block quote node.
- name: indentation | type: integer | description: Indentation level from 1-4.
- name: captionData | type: CaptionData | description: Data for a caption node.
- name: textStyle | type: TextStyle | description:
- name: layoutData | type: LayoutData | description: Data for a layout node. Reserved for future use.
- name: backgroundImage | type: BackgroundImage | description: Background image.
- name: media | type: Media | description: Background image.
- name: opacity | type: integer | description: Background image opacity.
- name: scaling | type: Scaling | description: Background image scaling.
- enum:
- AUTO: Auto image scaling
- CONTAIN: Contain image scaling
- COVER: Cover image scaling
- name: position | type: ImagePosition | description: Position of background. Defaults to `CENTER`.
- enum:
- CENTER: Image positioned at the center
- CENTER_LEFT: Image positioned on the left
- CENTER_RIGHT: Image positioned on the right
- TOP: Image positioned at the center top
- TOP_LEFT: Image positioned at the top left
- TOP_RIGHT: Image positioned at the top right
- BOTTOM: Image positioned at the center bottom
- BOTTOM_LEFT: Image positioned at the bottom left
- BOTTOM_RIGHT: Image positioned at the bottom right
- name: borderColor | type: string | description: Border color as a hexadecimal value.
- name: borderWidth | type: integer | description: Border width in pixels.
- name: borderRadius | type: integer | description: Border radius in pixels.
- name: backdropImage | type: BackgroundImage | description: Backdrop image.
- name: backdropPaddingTop | type: integer | description: Backdrop top padding.
- name: backdropPaddingBottom | type: integer | description: Backdrop bottom padding
- name: gap | type: integer | description: Horizontal and vertical gap between columns
- name: cellPadding | type: array | description: Padding in pixels for cells. Follows CSS order: top, right, bottom, left
- name: cellVerticalAlignment | type: Alignment | description: Vertical alignment for the cell's items.
- enum:
- TOP: Top alignment
- MIDDLE: Middle alignment
- BOTTOM: Bottom alignment
- name: responsivenessBehaviour | type: ResponsivenessBehaviour | description: Responsiveness behaviour of columns when responsiveness applies. Either stacks or wrappers.
- enum:
- STACK: Stacking of columns
- WRAP: Wrapping of columns
- name: responsivenessBreakpoint | type: integer | description: Size in pixels when responsiveness_behaviour applies
- name: containerData | type: PluginContainerData | description: Styling for the layout's container.
- name: designTarget | type: DesignTarget | description: Defines where selected design propertied applies to
- enum:
- LAYOUT: Design applied to layout
- CELL: Design applied to cells
- name: banner | type: Banner | description: Banner configuration. When present, this layout is attached to a document edge (top or bottom).
- name: origin | type: Origin | description: Origin of the banner
- enum:
- IMAGE: Banner originated from an image
- LAYOUT: Banner originated from a layout
- name: position | type: Position | description: Position of the banner
- enum:
- TOP: Attached to the top edge (banner)
- BOTTOM: Attached to the bottom edge (footer)
- name: background | type: Background | description: Background styling (color or gradient).
- name: type | type: Type | description: Background type.
- enum:
- COLOR: Solid color background
- GRADIENT: Gradient background
- name: color | type: string | description: Background color as a hexadecimal value.
- name: gradient | type: Gradient | description: Gradient configuration.
- name: backdrop | type: Backdrop | description: Backdrop styling (color or gradient).
- name: type | type: Type | description: Backdrop type.
- enum:
- COLOR: Solid color backdrop
- GRADIENT: Gradient backdrop
- name: color | type: string | description: Backdrop color as a hexadecimal value.
- name: gradient | type: Gradient | description: Gradient configuration.
- name: layoutCellData | type: LayoutCellData | description: Data for a cell node.
- name: colSpan | type: integer | description: Size of the cell in 12 columns grid.
- name: shapeData | type: ShapeData | description: Data for a shape node.
- name: containerData | type: PluginContainerData | description: Styling for the shape's container.
- name: shape | type: Media | description: Shape file details.
- name: styles | type: Styles | description: Styling for the shape.
- name: color | type: string | description: Shape fill color as a hexadecimal value.
- name: colors | type: object | description: Map of original color keys to their new color values.
- name: cardData | type: CardData | description: Data for a card node.
- name: background | type: Background | description: Background styling (color or gradient).
- name: type | type: Type | description: Background type.
- enum:
- COLOR: Solid color background
- GRADIENT: Gradient background
- name: color | type: string | description: Background color as a hexadecimal value.
- name: gradient | type: Gradient | description: Gradient configuration.
- name: backgroundImage | type: BackgroundImage | description: Background image.
- name: media | type: Media | description: Background image.
- name: opacity | type: integer | description: Background image opacity.
- name: scaling | type: Scaling | description: Background image scaling.
- enum:
- AUTO: Auto image scaling
- CONTAIN: Contain image scaling
- COVER: Cover image scaling
- name: position | type: Position | description: Position of background. Defaults to `CENTER`.
- enum:
- CENTER: Image positioned at the center
- CENTER_LEFT: Image positioned on the left
- CENTER_RIGHT: Image positioned on the right
- TOP: Image positioned at the center top
- TOP_LEFT: Image positioned at the top left
- TOP_RIGHT: Image positioned at the top right
- BOTTOM: Image positioned at the center bottom
- BOTTOM_LEFT: Image positioned at the bottom left
- BOTTOM_RIGHT: Image positioned at the bottom right
- name: tocData | type: TocData | description: Data for a table of contents node.
- name: includedHeadings | type: array | description: Heading levels included in the table of contents. Default: [1, 2, 3, 4, 5, 6].
- name: listStyle | type: ListStyle | description: List style. Default: PLAIN.
- enum:
- PLAIN: No markers (default)
- NUMBERED: Numbered list
- LETTERS: Alphabetic letters
- ROMAN: Roman numerals
- BULLETED: Bulleted list
- ALPHABETICAL_INDEX: Alphabetical index
- ALPHABETICAL_INDEX_COMPACT: Alphabetical index (compact top-row only)
- name: fontSize | type: number | description: Optional override for the font size in pixels.
- name: itemSpacing | type: number | description: Optional override for the vertical spacing between items in pixels.
- name: color | type: string | description: Optional override for the text color.
- name: indentation | type: Indentation | description: Indentation style. Default: NESTED.
- enum:
- NESTED: Sub-headings indented under parents (default)
- FLAT: All items at the same level
- name: smartBlockData | type: SmartBlockData | description: Data for a smart block node.
- name: type | type: Type | description: The type of the smart block.
- enum:
- SOLID_BOXES: Grid-based layouts with solid box items containing title, body, and icon/image.
- NUMBERED_BOXES: Numbered boxes.
- STATS: Statistics display with large numbers/values.
- CIRCLE_STATS: Statistics with circular visual elements.
- SOLID_BOXES_ALTERNATING: Staggered/zigzag grid layout with alternating box positions.
- SOLID_JOINED_BOXES: Grid layout with boxes visually joined (no gaps, shared container border).
- SIDE_LINE_TEXT: Transparent cells with only a left side line.
- TOP_LINE_TEXT: Transparent cells with only a top line.
- OUTLINE_BOXES_WITH_TOP_CIRCLE: Outlined boxes with a numbered/icon circle at the top.
- BIG_BULLETS: Large icon bullets with text content.
- SMALL_BULLETS: Small dot bullets with text content.
- ARROW_BULLETS: Arrow icon bullets with text content.
- PROCESS_STEPS: Process steps with numbered/icon labels above a horizontal line.
- BAR_STATS: Statistics with bar visual elements.
- TIMELINE: Timeline layout with numbered chips on a connecting line; cells alternate around the line.
- MINIMAL_TIMELINE: Timeline layout with plain dot indicators; no numbers or shapes; cells alternate around the line.
- PILLS: Numbered pill-shaped labels (stadium chips) with text content; supports HORIZONTAL (pill on top) and VERTICAL (pill on left) orientations.
- STAR_RATING: Star rating display with stars and a numeric value per cell.
- QUOTE_BOXES: Outlined boxes with decorative quote glyphs at the top-left and bottom-right corners.
- name: orientation | type: string | description: Layout orientation. HORIZONTAL or VERTICAL. Optional for variants with fixed orientation.
- name: columnSize | type: ColumnSize | description: Column size controlling cells per row.
- enum:
- SMALL: Up to 4 cells in a row.
- MEDIUM: Up to 3 cells in a row (default).
- LARGE: Up to 2 cells in a row.
- EXTRA_LARGE: 1 cell in a row.
- name: borderColor | type: string | description: Border color (for SOLID_JOINED_BOXES variant).
- name: borderWidth | type: integer | description: Border width in pixels (for SOLID_JOINED_BOXES variant).
- name: borderRadius | type: integer | description: Border radius in pixels (for SOLID_JOINED_BOXES variant).
- name: smartBlockCellData | type: SmartBlockCellData | description: Data for a smart block cell node.
- name: label | type: string | description: Optional label text for the cell (e.g., for stats variants).
- name: shape | type: Media | description: Shape file details.
- name: borderColor | type: string | description: Border color of the cell.
- name: borderWidth | type: integer | description: Border width in pixels.
- name: borderRadius | type: integer | description: Border radius in pixels.
- name: type | type: Type | description: The type of the parent smart block (must match parent).
- name: accentColor | type: string | description: Accent color for non-background variants (e.g., line, bullet, label color).
- name: backgroundColor | type: string | description: Background color for background-based variants (SOLID_BOXES, SOLID_BOXES_ALTERNATING, SOLID_JOINED_BOXES).
- name: shapeColor | type: string | description: Shape fill color as a hexadecimal value.
- name: type | type: Type | description: Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format.
- enum: PARAGRAPH, TEXT, HEADING, BULLETED_LIST, ORDERED_LIST, LIST_ITEM, BLOCKQUOTE, CODE_BLOCK, VIDEO, DIVIDER, FILE, GALLERY, GIF, HTML, IMAGE, LINK_PREVIEW, MAP, POLL, APP_EMBED, BUTTON, COLLAPSIBLE_LIST, TABLE, EMBED, COLLAPSIBLE_ITEM, COLLAPSIBLE_ITEM_TITLE, COLLAPSIBLE_ITEM_BODY, TABLE_CELL, TABLE_ROW, EXTERNAL, AUDIO, CAPTION, LAYOUT, LAYOUT_CELL, SHAPE, CARD, TOC, SMART_BLOCK, SMART_BLOCK_CELL
- name: _id | type: string | description: Node GUID.
- name: nodes | type: array | description: A list of child nodes.
- name: style | type: NodeStyle | description: Padding and background color styling for the node.
- name: paddingTop | type: string | description: The top padding value in pixels.
- name: paddingBottom | type: string | description: The bottom padding value in pixels.
- name: backgroundColor | type: string | description: The background color as a hexadecimal value.
- name: metadata | type: Metadata | description: Object metadata.
- name: version | type: integer | description: Schema version.
- name: _id | type: string | description: Object GUID.
- name: documentStyle | type: DocumentStyle | description: Global styling for header, paragraph, block quote, and code block nodes in the object.
- name: headerOne | type: TextNodeStyle | description: Styling for H1 nodes.
- name: decorations | type: array | description: The decorations to apply to the node.
- name: nodeStyle | type: NodeStyle | description: Padding and background color for the node.
- name: lineHeight | type: string | description: Line height for text in the node.
- name: headerTwo | type: TextNodeStyle | description: Styling for H2 nodes.
- name: headerThree | type: TextNodeStyle | description: Styling for H3 nodes.
- name: headerFour | type: TextNodeStyle | description: Styling for H4 nodes.
- name: headerFive | type: TextNodeStyle | description: Styling for H5 nodes.
- name: headerSix | type: TextNodeStyle | description: Styling for H6 nodes.
- name: paragraph | type: TextNodeStyle | description: Styling for paragraph nodes.
- name: blockquote | type: TextNodeStyle | description: Styling for block quote nodes.
- name: codeBlock | type: TextNodeStyle | description: Styling for code block nodes.
```
### Examples
### getMemberAbout
```javascript
import { membersAbout } from '@wix/members';
async function getMemberAbout(_id) {
const response = await membersAbout.getMemberAbout(_id);
};
```
### getMemberAbout (with elevated permissions)
```javascript
import { membersAbout } from '@wix/members';
import { auth } from '@wix/essentials';
async function myGetMemberAboutMethod(_id) {
const elevatedGetMemberAbout = auth.elevate(membersAbout.getMemberAbout);
const response = await elevatedGetMemberAbout(_id);
}
```
### getMemberAbout (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).
```javascript
import { createClient } from '@wix/sdk';
import { membersAbout } from '@wix/members';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed
const myWixClient = createClient ({
modules: { membersAbout },
// Include the auth strategy and host as relevant
});
async function getMemberAbout(_id) {
const response = await myWixClient.membersAbout.getMemberAbout(_id);
};
```
---