skills.rest
sugarcrm-developers
sugarcrm-developersOFFICIAL
Explore all skills by this author →
𝕏@sugarcrmdevGitHub

sugar-rest-endpoint

Generate custom REST API endpoints for SugarCRM modules by subclassing SugarApi or ModuleApi.

6|3|Updated Oct 27, 2025
Search Tags:#REST API#developer tool#custom endpoint#SugarCRM#module API
One-click install
npx skills add https://github.com/sugarcrm-developers/ai-for-sugar-devs --skill sugar-rest-endpoint
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sugar-rest-endpoint
Source: https://github.com/sugarcrm-developers/ai-for-sugar-devs/tree/main/skills/sugar-rest-endpoint
Command: npx skills add https://github.com/sugarcrm-developers/ai-for-sugar-devs --skill sugar-rest-endpoint

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires SugarApi, ModuleApi, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill simplifies the process of adding custom REST API endpoints to SugarCRM, allowing developers to expose module actions and data through a standardized interface.

Core Features & Use Cases

  • Custom Endpoint Creation: Build and register new REST endpoints with ease.
  • SugarApi Subclassing: Subclass SugarApi or ModuleApi to create endpoints.
  • Use Case: If you need to provide a RESTful API for a SugarCRM module, this Skill helps you create and manage the necessary classes and configurations.

Quick Start

Generate a REST endpoint for the 'Contacts' module that allows you to fetch a list of contacts with the following command: 'sugar-rest-endpoint generate contacts list'.

Frequently Asked Questions about sugar-rest-endpoint

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a custom REST API endpoint for a SugarCRM module?▼

You can create custom REST API endpoints for SugarCRM modules by subclassing SugarApi or ModuleApi, providing a standardized interface to expose module data and actions.

What do I need to build RESTful APIs in SugarCRM?▼

Building RESTful APIs in SugarCRM requires knowledge of the SugarCRM Extension Framework and RESTful principles to properly subclass SugarApi or ModuleApi for custom endpoint generation.

How do I expose module data through the SugarCRM REST API?▼

Expose SugarCRM module data by subclassing SugarApi or ModuleApi to build and register custom REST endpoints, providing a standardized interface for module actions and data retrieval.

When do I need to subclass SugarApi or ModuleApi?▼

Subclass SugarApi or ModuleApi when generating custom REST API endpoints for SugarCRM modules to expose specific module data and actions through a standardized RESTful interface.

What is the best way to add custom endpoints to SugarCRM?▼

The best way to add custom endpoints to SugarCRM is by subclassing SugarApi or ModuleApi, which provides a standardized method to expose module data and actions through RESTful interfaces.

Related Skills

Explore More Software Engineering Skills→
sugarcrm-developerssugarcrm-developers
6

sugar-custom-field-type

Create custom SugarCRM field types with PHP, JavaScript, and Handlebars templates.

Official
Intermediate
ericwang915ericwang915
38

http_request

Perform HTTP requests to any API endpoint with custom headers and JSON payloads.

Community
Intermediate
sugarcrm-developerssugarcrm-developers
6

sugar-custom-field

Adds custom fields to SugarCRM modules via Vardef Extension Framework.

Official
Intermediate
kvithayathilkvithayathil

design-an-interface

Generate multiple interface designs for software modules and compare them against design criteria.

Community
Intermediate