# BrevoRuby::UserApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**get_invited_users_list**](UserApi.md#get_invited_users_list) | **GET** /organization/invited/users | Get the list of all your users [**get_user_permission**](UserApi.md#get_user_permission) | **GET** /organization/user/{email}/permissions | Check user permission # **get_invited_users_list** > GetInvitedUsersList get_invited_users_list Get the list of all your users ### Example ```ruby # load the gem require 'brevo-ruby' # setup authorization BrevoRuby.configure do |config| # Configure API key authorization: api-key config.api_key['api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['api-key'] = 'Bearer' # Configure API key authorization: partner-key config.api_key['partner-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['partner-key'] = 'Bearer' end api_instance = BrevoRuby::UserApi.new begin #Get the list of all your users result = api_instance.get_invited_users_list p result rescue BrevoRuby::ApiError => e puts "Exception when calling UserApi->get_invited_users_list: #{e}" end ``` ### Parameters This endpoint does not need any parameter. ### Return type [**GetInvitedUsersList**](GetInvitedUsersList.md) ### Authorization [api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **get_user_permission** > GetUserPermission get_user_permission(email) Check user permission ### Example ```ruby # load the gem require 'brevo-ruby' # setup authorization BrevoRuby.configure do |config| # Configure API key authorization: api-key config.api_key['api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['api-key'] = 'Bearer' # Configure API key authorization: partner-key config.api_key['partner-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['partner-key'] = 'Bearer' end api_instance = BrevoRuby::UserApi.new email = 'email_example' # String | Email of the invited user. begin #Check user permission result = api_instance.get_user_permission(email) p result rescue BrevoRuby::ApiError => e puts "Exception when calling UserApi->get_user_permission: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **email** | **String**| Email of the invited user. | ### Return type [**GetUserPermission**](GetUserPermission.md) ### Authorization [api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json