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

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

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?