Let the platform do the work
SugarClubContact+1 (877) 842-7276

get_available_modules

Overview

Retrieves a list of available modules in the system.

Available APIs

  • SOAP
  • REST

Definition

get_available_modules(session, filter)

Parameters

Name Type Description
session String Session ID returned by a previous login call.
filter String String to filter the modules with. Possible values are 'default', 'mobile', 'all'.

Result

Name Type Description
result new_module_fields | Array The call result.
result.modules Array The list of avaialble modules.
result.modules[].module_key String The modules key.
result.modules[].module_label String The display label for the module.
result.modules[].favorite_enabled String Whether favorites are enabled for the module.
result.modules[].acls Array The ACL list for the module

Change Log

Version Change
v3 Added filter parameter. Accepts the values 'default', 'mobile', 'all'.

Examples

PHP

$get_available_modules_parameters = array(
    //Session id
    "session" => $session_id,

    //Module filter. Possible values are 'default', 'mobile', 'all'.
    "filter" => 'all',
);

Topics