GET

Get Roles Info


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 all available roles in the requesting account, including predefined and custom roles.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.

Endpoint
GET
https://www.wixapis.com/roles-management/roles

Query Params
localestring

Language of predefined roles names and descriptions to return, in ISO 639 format. Default: en.


filter.roleLevelstring

Role level to return. Default: ALL.


filter.editorTypesArray <string>

Filter for editor-specific roles. Default: ALL.

Response Object
predefinedRolesArray <RoleInfo>

Predefined roles.


customRolesArray <RoleInfo>

Custom roles.

Get Roles Info
Request
cURL
curl -X GET \ 'https://www.wixapis.com/roles-management/roles' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ -d '{ "filter": { "roleId": "6600344420111308827" } }'
Response
JSON
{ "predefinedRoles": [ { "id": "6601492336091027458", "title": "Owner", "description": "Can manage and access all aspects of sites, including billing and domains, plus invite other people and set their permissions." }, { "id": "6642345101181663232", "title": "Account Admin (Co-Owner)", "description": "Can manage and edit all sites and apps in the account, including billing, domains and inviting people, but cannot close account.", "restrictFromLevel": "Site" }, { "id": "6732588207941061632", "title": "Admin (Co-Owner)", "description": "Has access to edit, publish and manage site, including billing, payment & financial info, domains and inviting people, but can't delete or transfer the site.", "restrictFromLevel": "Account" } ], "customRoles": [ { "id": "7046409866117489206", "title": "This is a custom role test", "description": "This is a custom role test" }, { "id": "7231566973429198887", "title": "Another custom role" } ] }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?