{"id":"b8d1496c-1e00-4471-abbe-7655f7ba4935","createdDate":"2024-07-07T07:36:14.417Z","updatedDate":"2024-07-07T07:36:14.417Z","resourceId":"a5dbbbd7-c897-4e80-a7b0-04b6c92e4e56","api":{"schema":{"object":{"displayName":"Group Member Object","description":"","slug":"group-member-object","$ref":"#/components/schemas/wix.social.groups.api.v2.GroupMember","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/wix-groups.git"},"methods":[{"summary":"List Group Members","description":"Retrieves a list of up to 100 group members, given the provided paging.\nGroups mangers can retrieve group members of any group.","operationId":"wix.social.groups.api.v2.GroupMembersService.ListGroupMembers","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"groupId","description":"Group ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"limit","in":"query","description":"Number of items to load. Maximum `100.`","required":false,"schema":{"description":"Number of items to load. Maximum `100.`","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"offset","in":"query","description":"Number of items to skip in the current sort order.","required":false,"schema":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.social.groups.api.v2.ListGroupMembersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/social-groups-proxy/members","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/social-groups-proxy/members","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.social.groups.api.v2.GroupMembersService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.market:social-groups-api","serviceArtifactId":"com.wixpress.socialgroups.group-members-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.social.groups.api.v2.ListGroupMembersRequest","responseMessage":"wix.social.groups.api.v2.ListGroupMembersResponse"},"legacyExamples":[{"name":"ListGroupMembers","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://wixapis.com/social-groups/v2/groups/8a258cf5-49f3-41dc-b320-65ec2598315b/members?limit=100 \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"members\": [\n {\n \"siteMemberId\": \"223c37e0-3474-43c5-8d47-e374b414ef68\",\n \"role\": {\n \"value\": \"MEMBER\"\n },\n \"joinedDate\": \"2020-12-19T17:40:23Z\"\n },\n {\n \"siteMemberId\": \"88e40cba-392b-4333-8717-9375d57f4de7\",\n \"role\": {\n \"value\": \"ADMIN\"\n },\n \"joinedDate\": \"2020-09-17T09:17:56Z\"\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/wix-groups.git"},"httpMethod":"get","path":"/v2/groups/{groupId}/members","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.social.groups.api.v2.GroupMembersService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.market:social-groups-api","serviceArtifactId":"com.wixpress.socialgroups.group-members-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.social.groups.api.v2.ListGroupMembersRequest","responseMessage":"wix.social.groups.api.v2.ListGroupMembersResponse"},"legacyExamples":[{"name":"ListGroupMembers","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://wixapis.com/social-groups/v2/groups/8a258cf5-49f3-41dc-b320-65ec2598315b/members?limit=100 \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"members\": [\n {\n \"siteMemberId\": \"223c37e0-3474-43c5-8d47-e374b414ef68\",\n \"role\": {\n \"value\": \"MEMBER\"\n },\n \"joinedDate\": \"2020-12-19T17:40:23Z\"\n },\n {\n \"siteMemberId\": \"88e40cba-392b-4333-8717-9375d57f4de7\",\n \"role\": {\n \"value\": \"ADMIN\"\n },\n \"joinedDate\": \"2020-09-17T09:17:56Z\"\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/wix-groups.git","contentLink":{"displayName":"List Group Members","slugifiedName":"list-group-members"}},{"summary":"Add Group Members","description":"Add site members to a specific group.\nAdmins always have access to this functionality. Site owners may allow members to use this functionality as well.","operationId":"wix.social.groups.api.v2.GroupMembersService.AddGroupMembers","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"groupId","description":"Group ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.social.groups.api.v2.AddGroupMembersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/social-groups-proxy/members","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/social-groups-proxy/members","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"AddGroupMembersRequest","description":"","properties":{"siteMemberIds":{"description":"__Deprecated.__ Use `memberIds` instead.\nThis parameter will be removed on June 30, 2022.","format":"GUID","minItems":0,"maxItems":100,"title":"siteMemberIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"memberIds":{"description":"Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.","format":"GUID","minItems":0,"maxItems":100,"title":"memberIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["groupId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Group Member Added","description":"Triggered when a new member is added to a group, either directly by an admin or when a Join Request is approved.","permissions":[],"payload":{"schemaName":"wix.social.groups.api.v2.MemberAdded"},"exposure":"PUBLIC","maturity":"BETA","slug":"added","eventTopic":"domain_events_wix.social_groups.v2.group_member","serviceName":"wix.social.groups.api.v2.GroupMembersService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.social_groups.v2.group_member_added","sourceRepo":"git@github.com:wix-private/wix-groups.git"}],"serviceName":"wix.social.groups.api.v2.GroupMembersService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.market:social-groups-api","serviceArtifactId":"com.wixpress.socialgroups.group-members-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.social.groups.api.v2.AddGroupMembersRequest","responseMessage":"wix.social.groups.api.v2.AddGroupMembersResponse"},"legacyExamples":[{"name":"AddGroupMembers","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://wixapis.com/social-groups/v2/groups/a4caf853-c0d7-498e-8eaa-3db36522dcbf/members \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '\n -d '{\n \"siteMemberIds\": [\n \"e6674661-f294-4f1f-9f22-bc11fa8164e7\"\n ]\n }'\n~~~","response":"~~~json\n{\n \"members\": [\n {\n \"siteMemberId\": \"e6674661-f294-4f1f-9f22-bc11fa8164e7\",\n \"role\": {\n \"value\": \"MEMBER\"\n },\n \"joinedDate\": \"2020-12-19T17:40:23Z\"\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/wix-groups.git"},"httpMethod":"post","path":"/v2/groups/{groupId}/members","rpcOnly":false,"triggeredEvents":[{"title":"Group Member Added","description":"Triggered when a new member is added to a group, either directly by an admin or when a Join Request is approved.","permissions":[],"payload":{"schemaName":"wix.social.groups.api.v2.MemberAdded"},"exposure":"PUBLIC","maturity":"BETA","slug":"added","eventTopic":"domain_events_wix.social_groups.v2.group_member","serviceName":"wix.social.groups.api.v2.GroupMembersService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.social_groups.v2.group_member_added","sourceRepo":"git@github.com:wix-private/wix-groups.git"}],"serviceName":"wix.social.groups.api.v2.GroupMembersService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.market:social-groups-api","serviceArtifactId":"com.wixpress.socialgroups.group-members-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.social.groups.api.v2.AddGroupMembersRequest","responseMessage":"wix.social.groups.api.v2.AddGroupMembersResponse"},"legacyExamples":[{"name":"AddGroupMembers","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://wixapis.com/social-groups/v2/groups/a4caf853-c0d7-498e-8eaa-3db36522dcbf/members \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '\n -d '{\n \"siteMemberIds\": [\n \"e6674661-f294-4f1f-9f22-bc11fa8164e7\"\n ]\n }'\n~~~","response":"~~~json\n{\n \"members\": [\n {\n \"siteMemberId\": \"e6674661-f294-4f1f-9f22-bc11fa8164e7\",\n \"role\": {\n \"value\": \"MEMBER\"\n },\n \"joinedDate\": \"2020-12-19T17:40:23Z\"\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/wix-groups.git","contentLink":{"displayName":"Add Group Members","slugifiedName":"add-group-members"}},{"summary":"Remove Group Members","description":"Removes site members from a specific group.\nOnly admins have can remove members from a group.","operationId":"wix.social.groups.api.v2.GroupMembersService.RemoveGroupMembers","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"groupId","description":"Group ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"siteMemberIds","in":"query","description":"__Deprecated.__ Use `memberIds` instead.\nThis parameter will be removed on June 30, 2022.","required":false,"schema":{"description":"__Deprecated.__ Use `memberIds` instead.\nThis parameter will be removed on June 30, 2022.","format":"GUID","minItems":0,"maxItems":100,"title":"siteMemberIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}}},{"name":"memberIds","in":"query","description":"Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.","required":false,"schema":{"description":"Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.","format":"GUID","minItems":0,"maxItems":100,"title":"memberIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.social.groups.api.v2.RemoveGroupMembersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/social-groups-proxy/members","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/social-groups-proxy/members","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Group Member Removed","description":"","permissions":[],"payload":{"schemaName":"wix.social.groups.api.v2.MemberRemoved"},"exposure":"PUBLIC","maturity":"BETA","slug":"removed","eventTopic":"domain_events_wix.social_groups.v2.group_member","serviceName":"wix.social.groups.api.v2.GroupMembersService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.social_groups.v2.group_member_removed","sourceRepo":"git@github.com:wix-private/wix-groups.git"}],"serviceName":"wix.social.groups.api.v2.GroupMembersService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.market:social-groups-api","serviceArtifactId":"com.wixpress.socialgroups.group-members-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.social.groups.api.v2.RemoveGroupMembersRequest","responseMessage":"wix.social.groups.api.v2.RemoveGroupMembersResponse"},"legacyExamples":[{"name":"RemoveGroupMembers","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE \\\n https://wixapis.com/social-groups/v2/groups/a4caf853-c0d7-498e-8eaa-3db36522dcbf/members \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '\n -d '{\n \"siteMemberIds\": [\n \"e6674661-f294-4f1f-9f22-bc11fa8164e7\"\n ]\n }'\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/wix-groups.git"},"httpMethod":"delete","path":"/v2/groups/{groupId}/members","rpcOnly":false,"triggeredEvents":[{"title":"Group Member Removed","description":"","permissions":[],"payload":{"schemaName":"wix.social.groups.api.v2.MemberRemoved"},"exposure":"PUBLIC","maturity":"BETA","slug":"removed","eventTopic":"domain_events_wix.social_groups.v2.group_member","serviceName":"wix.social.groups.api.v2.GroupMembersService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.social_groups.v2.group_member_removed","sourceRepo":"git@github.com:wix-private/wix-groups.git"}],"serviceName":"wix.social.groups.api.v2.GroupMembersService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.market:social-groups-api","serviceArtifactId":"com.wixpress.socialgroups.group-members-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.social.groups.api.v2.RemoveGroupMembersRequest","responseMessage":"wix.social.groups.api.v2.RemoveGroupMembersResponse"},"legacyExamples":[{"name":"RemoveGroupMembers","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE \\\n https://wixapis.com/social-groups/v2/groups/a4caf853-c0d7-498e-8eaa-3db36522dcbf/members \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '\n -d '{\n \"siteMemberIds\": [\n \"e6674661-f294-4f1f-9f22-bc11fa8164e7\"\n ]\n }'\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/wix-groups.git","contentLink":{"displayName":"Remove Group Members","slugifiedName":"remove-group-members"}},{"summary":"Query Group Members","description":"Retrieves a list of up to 100 group members, given the provided paging, sorting and filtering.\nGroups mangers can retrieve group members of any group.\n\nSupported fields for filtering:\n- `role`\n\nSupported fields for sorting:\n- `joinedOn`\n- `role`","operationId":"wix.social.groups.api.v2.GroupMembersService.QueryGroupMembers","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"groupId","description":"Group ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.social.groups.api.v2.QueryGroupMembersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/social-groups-proxy/members","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/social-groups-proxy/members","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryGroupMembersRequest","description":"","properties":{"query":{"description":"","$ref":"#/components/schemas/wix.common.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["groupId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.social.groups.api.v2.GroupMembersService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.market:social-groups-api","serviceArtifactId":"com.wixpress.socialgroups.group-members-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.social.groups.api.v2.QueryGroupMembersRequest","responseMessage":"wix.social.groups.api.v2.QueryGroupMembersResponse"},"legacyExamples":[{"name":"QueryGroupMembers","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://wixapis.com/social-groups/v2/groups/8a258cf5-49f3-41dc-b320-65ec2598315b/members/query \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '\n -d '{\n \"query\": {\n \"filter\": {\n \"role\": {\n \"$eq\": \"ADMIN\"\n }\n },\n \"sort\": [\n {\n \"fieldName\": \"joinedOn\",\n \"order\": \"DESC\"\n }\n ],\n \"paging\": {\n \"offset\": 0,\n \"limit\": 100\n }\n }\n }'\n~~~","response":"~~~json\n{\n \"members\": [\n {\n \"siteMemberId\": \"223c37e0-3474-43c5-8d47-e374b414ef68\",\n \"role\": {\n \"value\": \"ADMIN\"\n },\n \"joinedDate\": \"2020-12-19T17:40:23Z\"\n },\n {\n \"siteMemberId\": \"88e40cba-392b-4333-8717-9375d57f4de7\",\n \"role\": {\n \"value\": \"ADMIN\"\n },\n \"joinedDate\": \"2020-09-17T09:17:56Z\"\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/wix-groups.git"},"httpMethod":"post","path":"/v2/groups/{groupId}/members/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.social.groups.api.v2.GroupMembersService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.market:social-groups-api","serviceArtifactId":"com.wixpress.socialgroups.group-members-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.social.groups.api.v2.QueryGroupMembersRequest","responseMessage":"wix.social.groups.api.v2.QueryGroupMembersResponse"},"legacyExamples":[{"name":"QueryGroupMembers","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://wixapis.com/social-groups/v2/groups/8a258cf5-49f3-41dc-b320-65ec2598315b/members/query \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '\n -d '{\n \"query\": {\n \"filter\": {\n \"role\": {\n \"$eq\": \"ADMIN\"\n }\n },\n \"sort\": [\n {\n \"fieldName\": \"joinedOn\",\n \"order\": \"DESC\"\n }\n ],\n \"paging\": {\n \"offset\": 0,\n \"limit\": 100\n }\n }\n }'\n~~~","response":"~~~json\n{\n \"members\": [\n {\n \"siteMemberId\": \"223c37e0-3474-43c5-8d47-e374b414ef68\",\n \"role\": {\n \"value\": \"ADMIN\"\n },\n \"joinedDate\": \"2020-12-19T17:40:23Z\"\n },\n {\n \"siteMemberId\": \"88e40cba-392b-4333-8717-9375d57f4de7\",\n \"role\": {\n \"value\": \"ADMIN\"\n },\n \"joinedDate\": \"2020-09-17T09:17:56Z\"\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/wix-groups.git","contentLink":{"displayName":"Query Group Members","slugifiedName":"query-group-members"}},{"summary":"List Memberships","description":"Retrieves a list of up to 100 members and their membership status, given the provided paging.\nGroups mangers can see all memberships for any group.","operationId":"wix.social.groups.api.v2.GroupMembersService.ListMemberships","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"memberId","description":"Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"limit","in":"query","description":"Number of items to load.","required":false,"schema":{"description":"Number of items to load.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"offset","in":"query","description":"Number of items to skip in the current sort order.","required":false,"schema":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.social.groups.api.v2.ListMembershipsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/social-groups-proxy/members","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/social-groups-proxy/members","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.social.groups.api.v2.GroupMembersService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.market:social-groups-api","serviceArtifactId":"com.wixpress.socialgroups.group-members-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.social.groups.api.v2.ListMembershipsRequest","responseMessage":"wix.social.groups.api.v2.ListMembershipsResponse"},"legacyExamples":[{"name":"ListMemberships","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://wixapis.com/social-groups/v2/members/223c37e0-3474-43c5-8d47-e374b414ef68/memberships?limit=100 \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"memberships\": [\n {\n \"groupId\": \"8a258cf5-49f3-41dc-b320-65ec2598315b\",\n \"status\": \"JOINED\",\n \"role\": {\n \"value\": \"ADMIN\"\n }\n },\n {\n \"groupId\": \"de4b9696-4292-41a6-8418-af53cfc78984\",\n \"status\": \"PENDING\"\n },\n {\n \"groupId\": \"3e3b08b6-9fdf-48b9-b2c3-762d6953fa0b\",\n \"status\": \"JOINED\",\n \"role\": {\n \"value\": \"MEMBER\"\n }\n }\n ],\n \"metadata\": {\n \"count\": 3,\n \"offset\": 0,\n \"total\": 3\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/wix-groups.git"},"httpMethod":"get","path":"/v2/members/{memberId}/memberships","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.social.groups.api.v2.GroupMembersService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.market:social-groups-api","serviceArtifactId":"com.wixpress.socialgroups.group-members-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.social.groups.api.v2.ListMembershipsRequest","responseMessage":"wix.social.groups.api.v2.ListMembershipsResponse"},"legacyExamples":[{"name":"ListMemberships","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n https://wixapis.com/social-groups/v2/members/223c37e0-3474-43c5-8d47-e374b414ef68/memberships?limit=100 \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"memberships\": [\n {\n \"groupId\": \"8a258cf5-49f3-41dc-b320-65ec2598315b\",\n \"status\": \"JOINED\",\n \"role\": {\n \"value\": \"ADMIN\"\n }\n },\n {\n \"groupId\": \"de4b9696-4292-41a6-8418-af53cfc78984\",\n \"status\": \"PENDING\"\n },\n {\n \"groupId\": \"3e3b08b6-9fdf-48b9-b2c3-762d6953fa0b\",\n \"status\": \"JOINED\",\n \"role\": {\n \"value\": \"MEMBER\"\n }\n }\n ],\n \"metadata\": {\n \"count\": 3,\n \"offset\": 0,\n \"total\": 3\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/wix-groups.git","contentLink":{"displayName":"List Memberships","slugifiedName":"list-memberships"}},{"summary":"Query Memberships","description":"Retrieves a list of up to 100 members and their membership status, given the provided paging and filtering.\nGroups mangers can see all memberships for any group.\n\nSupported fields for filtering:\n- `role`\n- `status`\n\nNo supported fields for sorting.","operationId":"wix.social.groups.api.v2.GroupMembersService.QueryMemberships","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"memberId","description":"Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.social.groups.api.v2.QueryMembershipsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/social-groups-proxy/members","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/social-groups-proxy/members","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryMembershipsRequest","description":"","properties":{"siteMemberId":{"description":"__Deprecated.__ Use the `memberId` path parameter instead.\nThis parameter will be removed on June 30, 2022.","format":"GUID","title":"siteMemberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"query":{"description":"","$ref":"#/components/schemas/wix.common.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["memberId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.social.groups.api.v2.GroupMembersService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.market:social-groups-api","serviceArtifactId":"com.wixpress.socialgroups.group-members-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.social.groups.api.v2.QueryMembershipsRequest","responseMessage":"wix.social.groups.api.v2.QueryMembershipsResponse"},"legacyExamples":[{"name":"QueryMemberships","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://wixapis.com/social-groups/v2/members/223c37e0-3474-43c5-8d47-e374b414ef68/memberships/query \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '\n -d '{\n \"query\": {\n \"filter\": {\n \"status\": {\n \"$eq\": \"JOINED\"\n }\n },\n \"paging\": {\n \"offset\": 0,\n \"limit\": 100\n }\n }\n }'\n~~~","response":"~~~json\n{\n \"memberships\": [\n {\n \"groupId\": \"8a258cf5-49f3-41dc-b320-65ec2598315b\",\n \"status\": \"JOINED\",\n \"role\": {\n \"value\": \"ADMIN\"\n }\n },\n {\n \"groupId\": \"3e3b08b6-9fdf-48b9-b2c3-762d6953fa0b\",\n \"status\": \"JOINED\",\n \"role\": {\n \"value\": \"MEMBER\"\n }\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/wix-groups.git"},"httpMethod":"post","path":"/v2/members/{memberId}/memberships/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.social.groups.api.v2.GroupMembersService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.market:social-groups-api","serviceArtifactId":"com.wixpress.socialgroups.group-members-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.social.groups.api.v2.QueryMembershipsRequest","responseMessage":"wix.social.groups.api.v2.QueryMembershipsResponse"},"legacyExamples":[{"name":"QueryMemberships","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n https://wixapis.com/social-groups/v2/members/223c37e0-3474-43c5-8d47-e374b414ef68/memberships/query \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: '\n -d '{\n \"query\": {\n \"filter\": {\n \"status\": {\n \"$eq\": \"JOINED\"\n }\n },\n \"paging\": {\n \"offset\": 0,\n \"limit\": 100\n }\n }\n }'\n~~~","response":"~~~json\n{\n \"memberships\": [\n {\n \"groupId\": \"8a258cf5-49f3-41dc-b320-65ec2598315b\",\n \"status\": \"JOINED\",\n \"role\": {\n \"value\": \"ADMIN\"\n }\n },\n {\n \"groupId\": \"3e3b08b6-9fdf-48b9-b2c3-762d6953fa0b\",\n \"status\": \"JOINED\",\n \"role\": {\n \"value\": \"MEMBER\"\n }\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/wix-groups.git","contentLink":{"displayName":"Query Memberships","slugifiedName":"query-memberships"}}],"webhooks":[{"summary":"Member Added","title":"Group Member Added","description":"Triggered when a new member is added to a group, either directly by an admin or when a Join Request is approved.","permissions":[],"payload":{"schemaName":"wix.social.groups.api.v2.MemberAdded"},"exposure":"PUBLIC","maturity":"BETA","slug":"added","eventTopic":"domain_events_wix.social_groups.v2.group_member","serviceName":"wix.social.groups.api.v2.GroupMembersService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.social_groups.v2.group_member_added","legacyExamples":[{"name":"MemberAdded","eventType":"ADDED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"9f6efd56-6532-4620-848e-122b990d425d\",\n \"entityFqdn\": \"wix.social_groups.v2.group_member\",\n \"slug\": \"added\",\n \"entityId\": \"7df3de0d-146b-4569-8891-b3920386ba2e\",\n \"actionEvent\": {\n \"body\": {\n \"groupId\": \"97df3de0d-146b-4569-8891-b3920386ba2e\",\n \"groupMember\": {\n \"siteMemberId\": \"7df3de0d-146b-4569-8891-b3920386ba2e\",\n \"role\": { \"value\": \"MEMBER\" },\n \"joinedDate\": \"2021-02-16T07:45:54Z\"\n }\n }\n },\n \"eventTime\": \"2021-02-16T07:45:56.926855Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/wix-groups.git","$ref":"#/components/schemas/wix.social.groups.api.v2.MemberAdded","contentLink":{"displayName":"Member Added","slugifiedName":"member-added"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Member Removed","title":"Group Member Removed","description":"","permissions":[],"payload":{"schemaName":"wix.social.groups.api.v2.MemberRemoved"},"exposure":"PUBLIC","maturity":"BETA","slug":"removed","eventTopic":"domain_events_wix.social_groups.v2.group_member","serviceName":"wix.social.groups.api.v2.GroupMembersService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.social_groups.v2.group_member_removed","legacyExamples":[{"name":"MemberRemoved","eventType":"REMOVED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"22c8c81c-457c-4ae9-9669-5dd453c2c1ee\",\n \"entityFqdn\": \"wix.social_groups.v2.group_member\",\n \"slug\": \"removed\",\n \"entityId\": \"7df3de0d-146b-4569-8891-b3920386ba2e\",\n \"actionEvent\": {\n \"body\": {\n \"groupId\": \"97df3de0d-146b-4569-8891-b3920386ba2e\",\n \"groupMember\": {\n \"siteMemberId\": \"7df3de0d-146b-4569-8891-b3920386ba2e\",\n \"role\": { \"value\": \"ADMIN\" },\n \"joinedDate\": \"2021-02-05T09:58:34Z\"\n }\n }\n },\n \"eventTime\": \"2021-02-15T23:11:17.267804Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/wix-groups.git","$ref":"#/components/schemas/wix.social.groups.api.v2.MemberRemoved","contentLink":{"displayName":"Member Removed","slugifiedName":"member-removed"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[],"components":{"schemas":{"wix.social.groups.api.v2.GroupMember":{"type":"object","properties":{"siteMemberId":{"description":"__Deprecated.__ Use `memberId` instead.\nThis property will be removed on June 30, 2022.","readOnly":true,"format":"GUID","title":"siteMemberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"memberId":{"description":"Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details.","readOnly":true,"format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"role":{"description":"Group Member Role.","$ref":"#/components/schemas/wix.social.groups.api.v2.GroupRole","summary":"role","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"joinedDate":{"description":"Date and time the group Member joined the group.","readOnly":true,"title":"joinedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GroupMember","description":""},"wix.social.groups.api.v2.GroupRole":{"type":"object","properties":{"value":{"description":"Member's role.\n- `MEMBER` - Regular group member.\n- `ADMIN` - Group administrator.","title":"value","type":"string","$ref":"#/components/schemas/wix.social.groups.api.v2.GroupRole.Role","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GroupRole","description":"A group member may have multiple roles in a single group.\nCurrently, only `MEMBER` and `ADMIN` roles are supported, but more roles may be available in the future."},"wix.social.groups.api.v2.GroupRole.Role":{"type":"string","description":"","title":"Role","enum":["UNKNOWN_ROLE","MEMBER","ADMIN"]},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"wix.social.groups.api.v1.events.SocialGroupsEvent":{"type":"object","properties":{},"title":"SocialGroupsEvent","description":"","oneOf":[{"description":"","summary":"payload","$ref":"#/components/schemas/wix.social.groups.api.v1.events.SocialGroupsEvent.payload"}]},"wix.social.groups.api.v1.events.SocialGroupsEvent.payload":{"type":"object","title":"payload","properties":{"memberJoined":{"description":"","$ref":"#/components/schemas/wix.social.groups.api.v1.events.MemberJoinedGroup","summary":"memberJoined","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"membersAdded":{"description":"","$ref":"#/components/schemas/wix.social.groups.api.v1.events.MembersAddedToGroup","summary":"membersAdded","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"joinRequestsApproved":{"description":"","$ref":"#/components/schemas/wix.social.groups.api.v1.events.JoinRequestsApproved","summary":"joinRequestsApproved","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"membersInvited":{"description":"","$ref":"#/components/schemas/wix.social.groups.api.v1.events.MembersInvitedToGroup","summary":"membersInvited","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.social.groups.api.v1.events.MemberJoinedGroup":{"type":"object","properties":{"groupId":{"description":"","format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupsInstanceId":{"description":"","format":"GUID","title":"groupsInstanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMemberId":{"description":"","format":"GUID","title":"siteMemberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MemberJoinedGroup","description":""},"wix.social.groups.api.v1.events.MembersAddedToGroup":{"type":"object","properties":{"groupId":{"description":"","format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupsInstanceId":{"description":"","format":"GUID","title":"groupsInstanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"whoAddedId":{"description":"","format":"GUID","title":"whoAddedId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMemberIds":{"description":"","format":"GUID","title":"siteMemberIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"operationId":{"description":"Used for Apes sticky experiment","format":"GUID","title":"operationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MembersAddedToGroup","description":""},"wix.social.groups.api.v1.events.JoinRequestsApproved":{"type":"object","properties":{"groupId":{"description":"","format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupsInstanceId":{"description":"","format":"GUID","title":"groupsInstanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMemberIds":{"description":"","format":"GUID","title":"siteMemberIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"operationId":{"description":"Used for Apes sticky experiment","format":"GUID","title":"operationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"JoinRequestsApproved","description":""},"wix.social.groups.api.v1.events.MembersInvitedToGroup":{"type":"object","properties":{"groupId":{"description":"","format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupsInstanceId":{"description":"","format":"GUID","title":"groupsInstanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMemberIds":{"description":"","format":"GUID","title":"siteMemberIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MembersInvitedToGroup","description":""},"wix.social.groups.api.v2.JoinRequest":{"type":"object","properties":{"groupId":{"description":"","format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"membershipQuestionAnswers":{"description":"Answers to membership questions. A Join Request will fail, if the answer to a required question is omitted.","maxItems":50,"title":"membershipQuestionAnswers","type":"array","items":{"$ref":"#/components/schemas/wix.social.groups.api.v2.MembershipQuestionAnswer"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"autoInviteId":{"description":"","title":"autoInviteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"JoinRequest","description":"ID of the group to join."},"wix.social.groups.api.v2.MembershipQuestionAnswer":{"type":"object","properties":{"id":{"description":"Question ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"text":{"description":"Answer text.","minLength":0,"maxLength":300,"title":"text","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MembershipQuestionAnswer","description":"Answer to a membership question."},"wix.social.groups.api.v2.JoinResponse":{"type":"object","properties":{"member":{"description":"New member.","$ref":"#/components/schemas/wix.social.groups.api.v2.GroupMember","summary":"member","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"JoinResponse","description":""},"wix.social.groups.api.v2.MemberJoined":{"type":"object","properties":{"groupId":{"description":"Group ID that member has joined.","format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupMember":{"description":"Joined group member.","$ref":"#/components/schemas/wix.social.groups.api.v2.GroupMember","summary":"groupMember","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MemberJoined","description":""},"wix.social.groups.api.v2.MemberJoined.JoinBy":{"type":"string","description":"","title":"JoinBy","enum":["MANUALLY","PERSONAL_INVITE_LINK","PUBLIC_INVITE_LINK"]},"wix.social.groups.api.v2.LeaveRequest":{"type":"object","properties":{"groupId":{"description":"ID of the Group to leave.","format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LeaveRequest","description":""},"wix.social.groups.api.v2.LeaveResponse":{"type":"object","properties":{},"title":"LeaveResponse","description":""},"wix.social.groups.api.v2.MemberLeft":{"type":"object","properties":{"groupId":{"description":"Group ID that member has left.","format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupMember":{"description":"Group member that left.","$ref":"#/components/schemas/wix.social.groups.api.v2.GroupMember","summary":"groupMember","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MemberLeft","description":""},"wix.social.groups.api.v2.AddGroupMembersRequest":{"type":"object","properties":{"groupId":{"description":"Group ID.","format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMemberIds":{"description":"__Deprecated.__ Use `memberIds` instead.\nThis parameter will be removed on June 30, 2022.","format":"GUID","minItems":0,"maxItems":100,"title":"siteMemberIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"memberIds":{"description":"Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.","format":"GUID","minItems":0,"maxItems":100,"title":"memberIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddGroupMembersRequest","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.social.groups.api.v2.AddGroupMembersResponse":{"type":"object","properties":{"members":{"description":"New members.","title":"members","type":"array","items":{"$ref":"#/components/schemas/wix.social.groups.api.v2.GroupMember"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddGroupMembersResponse","description":""},"wix.social.groups.api.v2.MemberAdded":{"type":"object","properties":{"groupId":{"description":"Group ID that member was added to.","format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupMember":{"description":"Added group member.","$ref":"#/components/schemas/wix.social.groups.api.v2.GroupMember","summary":"groupMember","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MemberAdded","description":""},"wix.social.groups.api.v2.RemoveGroupMembersRequest":{"type":"object","properties":{"groupId":{"description":"Group ID.","format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMemberIds":{"description":"__Deprecated.__ Use `memberIds` instead.\nThis parameter will be removed on June 30, 2022.","format":"GUID","minItems":0,"maxItems":100,"title":"siteMemberIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"memberIds":{"description":"Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.","format":"GUID","minItems":0,"maxItems":100,"title":"memberIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveGroupMembersRequest","description":""},"wix.social.groups.api.v2.RemoveGroupMembersResponse":{"type":"object","properties":{},"title":"RemoveGroupMembersResponse","description":""},"wix.social.groups.api.v2.MemberRemoved":{"type":"object","properties":{"groupId":{"description":"Group ID that member was removed from.","format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupMember":{"description":"Removed group member.","$ref":"#/components/schemas/wix.social.groups.api.v2.GroupMember","summary":"groupMember","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MemberRemoved","description":""},"wix.social.groups.api.v2.ListGroupMembersRequest":{"type":"object","properties":{"groupId":{"description":"Group ID.","format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"Number of items to load. Maximum `100.`","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListGroupMembersRequest","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"wix.social.groups.api.v2.ListGroupMembersResponse":{"type":"object","properties":{"members":{"description":"Retrieved members.","title":"members","type":"array","items":{"$ref":"#/components/schemas/wix.social.groups.api.v2.GroupMember"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Paging information.","$ref":"#/components/schemas/wix.common.PagingMetadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListGroupMembersResponse","description":""},"wix.common.PagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadata","description":""},"wix.social.groups.api.v2.QueryGroupMembersRequest":{"type":"object","properties":{"groupId":{"description":"Group ID.","format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"query":{"description":"","$ref":"#/components/schemas/wix.common.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryGroupMembersRequest","description":""},"wix.common.Query":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paging":{"description":"Paging options to limit and skip the number of items.","$ref":"#/components/schemas/wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.","title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.","title":"fieldsets","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Query","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"wix.social.groups.api.v2.QueryGroupMembersResponse":{"type":"object","properties":{"members":{"description":"Group members.","title":"members","type":"array","items":{"$ref":"#/components/schemas/wix.social.groups.api.v2.GroupMember"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Paging information.","$ref":"#/components/schemas/wix.common.PagingMetadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryGroupMembersResponse","description":""},"wix.social.groups.api.v2.QueryNonGroupMembersRequest":{"type":"object","properties":{"groupId":{"description":"Group ID.","format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"query":{"description":"","$ref":"#/components/schemas/wix.common.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryNonGroupMembersRequest","description":""},"wix.social.groups.api.v2.QueryNonGroupMembersResponse":{"type":"object","properties":{"members":{"description":"Retrieved members.","title":"members","type":"array","items":{"$ref":"#/components/schemas/wix.social.groups.api.v2.GroupMember"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryNonGroupMembersResponse","description":""},"wix.social.groups.api.v2.ListMembershipsRequest":{"type":"object","properties":{"memberId":{"description":"Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"Number of items to load.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListMembershipsRequest","description":""},"wix.social.groups.api.v2.ListMembershipsResponse":{"type":"object","properties":{"memberships":{"description":"Site member's memberships.","title":"memberships","type":"array","items":{"$ref":"#/components/schemas/wix.social.groups.api.v2.Membership"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Paging information.","$ref":"#/components/schemas/wix.common.PagingMetadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListMembershipsResponse","description":""},"wix.social.groups.api.v2.Membership":{"type":"object","properties":{"groupId":{"description":"Group ID.","readOnly":true,"format":"GUID","title":"groupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Membership status with Group\n- `JOINED` - Site member is a group member.\n- `PENDING` - Site member has submitted a Join Request for this group that is still `PENDING`.","title":"status","type":"string","$ref":"#/components/schemas/wix.social.groups.api.v2.Membership.MembershipStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"role":{"description":"Group member role. When membership status is not `JOINED`, this is empty.","$ref":"#/components/schemas/wix.social.groups.api.v2.GroupRole","summary":"role","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Membership","description":""},"wix.social.groups.api.v2.Membership.MembershipStatus":{"type":"string","description":"","title":"MembershipStatus","enum":["UNKNOWN_STATUS","JOINED","PENDING"]},"wix.social.groups.api.v2.QueryMembershipsRequest":{"type":"object","properties":{"siteMemberId":{"description":"__Deprecated.__ Use the `memberId` path parameter instead.\nThis parameter will be removed on June 30, 2022.","format":"GUID","title":"siteMemberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"memberId":{"description":"Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"query":{"description":"","$ref":"#/components/schemas/wix.common.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryMembershipsRequest","description":""},"wix.social.groups.api.v2.QueryMembershipsResponse":{"type":"object","properties":{"memberships":{"description":"Site member's memberships.","title":"memberships","type":"array","items":{"$ref":"#/components/schemas/wix.social.groups.api.v2.Membership"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Paging information.","$ref":"#/components/schemas/wix.common.PagingMetadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryMembershipsResponse","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp.","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Group Member","description":"","fqdn":"wix.social_groups.v2.group_member"},"articles":[]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}