Group Member Object
Properties
siteMemberIdstringRead-onlyformat GUID

Deprecated. Use memberId instead. This property will be removed on June 30, 2022.

memberIdstringRead-onlyformat GUID

Member ID. See Members API for more details.

roleobject

Group Member Role.

joinedDatestringRead-onlyformat date-time

Date and time the group Member joined the group.

Was this helpful?
Yes
No
GetList Group Members
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 100 group members, given the provided paging. Groups mangers can retrieve group members of any group.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/social-groups/v2/groups/{groupId}/members
Was this helpful?
Yes
No
PostAdd Group Members
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Add site members to a specific group. Admins always have access to this functionality. Site owners may allow members to use this functionality as well.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/social-groups/v2/groups/{groupId}/members
Event TriggersThis method triggers the following events:
Group Member Added
Was this helpful?
Yes
No
DeleteRemove Group Members
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Removes site members from a specific group. Only admins have can remove members from a group.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.
Endpoint
DELETE
https://www.wixapis.com/social-groups/v2/groups/{groupId}/members
Event TriggersThis method triggers the following events:
Group Member Removed
Was this helpful?
Yes
No
PostQuery Group Members
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 100 group members, given the provided paging, sorting and filtering. Groups mangers can retrieve group members of any group.

Supported fields for filtering:

  • role

Supported fields for sorting:

  • joinedOn
  • role

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/social-groups/v2/groups/{groupId}/members/query
Was this helpful?
Yes
No
GetList Memberships
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 100 members and their membership status, given the provided paging. Groups mangers can see all memberships for any group.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/social-groups/v2/members/{memberId}/memberships
Was this helpful?
Yes
No
PostQuery Memberships
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 100 members and their membership status, given the provided paging and filtering. Groups mangers can see all memberships for any group.

Supported fields for filtering:

  • role
  • status

No supported fields for sorting.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/social-groups/v2/members/{memberId}/memberships/query
Was this helpful?
Yes
No
Member Added
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a new member is added to a group, either directly by an admin or when a Join Request is approved.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.social_groups.v2.group_member.

slugstring

Event name. Expected added.

entityIdstring

ID of the entity associated with the event.

eventTimestringformat date-time

Event timestamp.

triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring

If present, indicates the action that triggered the event.

actionEventobject

Event information.


Was this helpful?
Yes
No
Member Removed
Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.social_groups.v2.group_member.

slugstring

Event name. Expected removed.

entityIdstring

ID of the entity associated with the event.

eventTimestringformat date-time

Event timestamp.

triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring

If present, indicates the action that triggered the event.

actionEventobject

Event information.


Was this helpful?
Yes
No