getRolesInfo( )

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.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
SCOPE.ACCOUNT.BASIC_TEAM_MEMBER
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsGetRolesInfoOptions

Filter options.

Returns
Return Type:Promise<GetRolesInfoResponse>
Errors

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

Did this help?