Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

value

BoolValue

Int32Value

values

ListValue

NullValue

StringValue

fields

Struct

nanos

seconds

Timestamp

Value

boolValue

listValue

nullValue

numberValue

stringValue

structValue

kind

limit

Number of items to skip in the current sort order.

offset

Paging

Number of items returned in the response.

count

Flag that indicates the server failed to calculate the `total` field.

tooManyToCount

Total number of items that match the query.

total

PagingMetadata

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.

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.

fieldsets

Filter object in the following format:
`"filter" : {
"fieldName1": "value1",
"fieldName2":{"$operator":"value2"}
}`
Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`

filter

Paging options to limit and skip the number of items.

Sort object in the following format:
`[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`

sort

Query

SortOrder

fieldName

order

Sorting

ApproveAllJoinGroupRequestsRequest

joinGroupRequests

ApproveAllJoinGroupRequestsResponse

groupId

Member IDs to approve.

<blockquote class='important'>

__Important:__
This parameter will be required after the deprecated `siteMemberIds` is removed
on June 30, 2022.

</blockquote>

memberIds

__Deprecated.__ Use `memberIds` instead.
This parameter will be removed on June 30, 2022.

Required if `memberIds` is not provided.

siteMemberIds

ApproveJoinGroupRequestsRequest

ApproveJoinGroupRequestsResponse

CancelJoinGroupRequestRequest

CancelJoinGroupRequestResponse

autoInviteId

Answers to membership questions. They can be empty, but submit join group request will fail if an answer to a required question is omitted.

membershipQuestionAnswers

GetJoinRequirementsRequest

GetJoinRequirementsResponse

violationType

Violation

Events which allow user to join the group.

eventIds

EventsViolationOptions

requiredQuestionIds

MembershipQuestionViolationOptions

Plan ids which user have, but they don't allow to join group right now, because they start some time in the future.

futurePlans

installed

Plan ids which allow user to join the group.

requiredPlans

PricingPlanViolationOptions

name

planId

startsAt

PaidPlan

ViolationType

violationOptions

ItemsToUpdate

To join a private group, a site member must submit a Join Request, which can be approved or rejected by an admin.
When the request is approved, the site member becomes a group member.

Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details.

siteMemberId

Join group request status.
- `PENDING` - Pending join group request.
- `APPROVED` - Approved join group request.
- `REJECTED` - Rejected join group request.
- `CANCELED` - Canceled join group request.

status

JoinGroupRequest

Group ID for which join request was approved.

JoinGroupRequestApproved

Group ID for which join request was cancelled.

JoinGroupRequestCancelled

Group ID for which join request was rejected.

JoinGroupRequestRejected

ListAllJoinGroupRequestsRequest

ListAllJoinGroupRequestsResponse

ListJoinGroupRequestsRequest

ListJoinGroupRequestsResponse

text

MembershipQuestionAnswer

OwnershipFilter

QueryJoinGroupRequestsRequest

QueryJoinGroupRequestsResponse

RejectAllJoinGroupRequestsRequest

RejectAllJoinGroupRequestsResponse

rejections

RejectJoinGroupRequestsRequest

memberId

Rejection reason. Free text that will be displayed to the rejected site member (max 1,000 characters).

reason

Rejection

RejectJoinGroupRequestsResponse

rejectionReason

RequestDetails

RequestStatus

SubmitJoinGroupRequestRequest

SubmitJoinGroupRequestResponse

Retrieves a list of up to 100 join group requests, given the provided paging.
Group managers always have access to this functionality (site members can access their own join group requests in the site).

Manage Social Groups

ListJoinGroupRequests

Approves pending join group requests.
Group managers always have access to this functionality. In some cases, site owners will allow group members to use this functionality as well.

ApproveJoinGroupRequests

Triggered when a join group request is approved by a group admin or a groups manager.

Join Group Request Approved

Rejects pending join group requests.
Group managers always have access to this functionality. In some cases, site owners will allow group members to use this functionality as well.

RejectJoinGroupRequests

Triggered when a join group request is rejected by a group admin or a groups manager.

Join Group Request Rejected

Retrieves a list of up to 100 join group requests, given the provided paging and filtering.
Group managers always have access to this functionality (site members can access their own join group requests in the site).

Supported fields for filtering:
- `status`

No supported fields for sorting

Approve Join Group Requests

Permission Scopes