About the Contributors API

The Contributors API allows account managers to retrieve a list of contributors for a given site and to change the contributors' roles for the site. This API enables you to manage contributor roles and permissions, so you can ensure that your customers have the appropriate access to their Wix sites.

Important:

This API is designed to manage customer access to a single site and is not intended for managing company employee access to sites.

For more information about site collaborators, including a list of available roles, see Roles & Permissions: Overview and Roles & Permissions: Information for Site Collaborators.

Before you begin

  • Wix recommends mapping your customers' identifiers (email, name, etc.) to their Wix user ID.
  • There is currently no way to retrieve a contributor's current roles via API.

Terminology

  • Account: A collection of Wix assets, including sites, managed by one or more Wix users. Every Wix user has an account that they own, and they can also be invited to join other user's accounts.
  • Assignment: The mapping of a Wix user's access to a site and their assigned role. For example, Sally has access to the XYZ site owned by Jennifer with a website manager role.
  • Collaborator: A Wix user with edit or manage access to a site owned by a separate Wix account. See Roles & Permissions: Overview and Roles & Permissions: Information for Site Collaborators.
  • Policy: See Role below.
  • Role: A defined type of access that an identity should have on a specific site or account. Wix provides several predefined roles, such as co-owner, website manager, and website designer. Account owners and co-owners can also define their own custom roles.
  • User: A logged in user on *.wix.com.
Did this help?

Contributor Object


Properties
metaDataMetaData

Contributor's metadata.


isTeamboolean

Whether the contributor account is a team account.


joinedAtstringformat date-time

Date that the contributor joined the site.


invitedEmailstring

Email address that received the invite.


isClientboolean

Whether the contributor account is a client account.


idstringRead-onlyformat GUID

Contributor's user ID.

Did this help?

PUT

Change Role


Developer Preview

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

Overrides all the roles of a contributor for the specified site.

Endpoint
PUT
https://www.wixapis.com/roles-management/contributor/change/role

Body Params
accountIdstringRequiredformat GUID

Contributor's account ID.


newRolesArray <SiteRoleAssignment>Required

New roles to assign to the contributor on the site.

Response Object
newAssignedRolesArray <SiteRoleAssignment>

New roles assigned to the contributor on the site.

Change contributor role
Request
cURL
curl -X PATCH \ 'https://www.wixapis.com/roles-management/contributor/change/role' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ -d '{ "accountId": "fed9597b-00a1-4bd6-0000-aff2ec248e7a", "newRoles": [ { "roleId": "6600344420111308827", } ] }'
Response
JSON
{ "newAssignedRoles": [ { "roleId": "6600344420111308827", "assignmentId": "7261756085891267597" } ] }
Did this help?

GET

Query Site Contributors


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 contributors for the specified site, given the provided filters.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/roles-management/v2/contributors/query

Query Params
filterFiltermaxItems 20
Response Object
contributorsArray <ContributorV2>

List of site contributors.

Get Roles Info
Request
cURL
curl -X GET \ 'https://www.wixapis.com/roles-management/v2/contributors/query' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ -d '{ "filter": { "policyIds": [ "6600344420111308827" ] } }'
Response
JSON
{ "contributors": [ { "accountId": "b1eb9bab-b71c-4a123-b84e-5b5b4c869e64", "accountOwnerId": "b1eb9bab-b80c-4a123-b84e-5b5b4c869e00" } ] }
Did this help?