Sugar Developer Guide Version 5.1

Entry Points

The primary user interface entry point for Sugar is through index.php located in the root Sugar folder. There are three main parameters for most calls within Sugar, they are:

•	module: The module to be accessed as part of the call

•	action: The action to be taken by the application within the module

•	record: The record id to be accessed

An example URL for a Sugar call might be:

http://www.yoursugarsite.com/index.php?module=Contacts&action=DetailView&record=d545d1dd-0cb2-d614-3430-45df72473cfb

This URL invokes the DetailView action from within the Contacts module to display the record denoted by the record request value.

Other commonly used parameters are ‘return_module’, ‘return_action’, return_id’. This group of request parameters are typically used when a user selects to cancel out of an action such as when creating/editing a record.

Note: For version 5.1 most entry points were consolidated into index.php. Previous versions had other files as entry points into the application.