canonical: https://jentic.com/apis/sugarcrm.com/sugarcrm

# SugarCRM REST API

SugarCRM REST API for managing CRM data including records, modules, relationships, and authentication via OAuth2. The API exposes 10 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically authenticate via oauth2, create a record. Covers 10 operations with oauth2 authentication.

## Scope

Does not handle payments, communications, or crm - use for identity and authentication only.

## Capabilities

- Authenticate via OAuth2
- Create a record
- List records in a module
- Retrieve a record
- Update a record
- Delete a record

## Use cases

### Identity and Authentication Operations

Use the SugarCRM REST API to perform identity auth operations programmatically. The API provides 10 endpoints covering core functionality including authenticate via oauth2, create a record, list records in a module.

Example prompt: Call POST `/oauth2/token` to authenticate via oauth2

### Automated Authentication Management

Automate authentication operations by combining multiple SugarCRM REST API endpoints. Agents can create a record and then list records in a module in a single workflow.

Example prompt: Call POST /{module} to create a record, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SugarCRM REST API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle oauth2 tokens manually.

Example prompt: Search Jentic for 'authenticate via oauth2', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/oauth2/token` | Authenticate via OAuth2 |
| POST | `/{module}` | Create a record |
| GET | `/{module}` | List records in a module |
| GET | `/{module}/{record_id}` | Retrieve a record |
| PUT | `/{module}/{record_id}` | Update a record |
| DELETE | `/{module}/{record_id}` | Delete a record |
| POST | `/{module}/{record_id}/link/{link_name}` | Create a related record |
| GET | `/{module}/{record_id}/link/{link_name}` | Get related records |

## Key resources

- **Authentication** — Operations related to Authentication
- **Metadata** — Operations related to Metadata
- **Records** — Operations related to Records
- **Relationships** — Operations related to Relationships

## Why Jentic

- **Setup:** Wiring the SugarCRM REST API by hand means running its OAuth2 password flow against your own site URL, refreshing tokens, and mapping module and record ids yourself. Through Jentic you install once, import the SugarCRM REST API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** SugarCRM puts the module and record id in the URL path (/{module}/{record_id}), so a rule can pin your agent to one record: it can read and update that record and nothing else. You choose the operations it may call, so destructive ones like deleting a record are not included unless you add them.
- **Credential handling:** Your SugarCRM OAuth2 credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'authenticate a session' or 'retrieve a record', and Jentic returns the matching SugarCRM operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Auth0** — Alternative identity auth API
- **Okta** — Alternative identity auth API

## FAQ

### What authentication does the SugarCRM REST API use?

The SugarCRM REST API uses OAuth 2.0 for authorization. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I authenticate via oauth2 with the SugarCRM REST API?

Yes. Use the POST `/oauth2/token` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the SugarCRM REST API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I authenticate via oauth2 through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'authenticate via oauth2'. Jentic returns the matching SugarCRM REST API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the SugarCRM REST API have?

The SugarCRM REST API exposes 10 endpoints covering authentication, metadata, records operations.

### Can I limit what my agent is allowed to do with the SugarCRM REST API?

Yes. Because Jentic One is self-hosted, your own rules decide which SugarCRM operations and credentials the agent can use. Since SugarCRM puts the module and record id in the URL path (/{module}/{record_id}), you can pin the agent to a single record so it only reads and updates that record and nothing else. You choose the operations it may call, so destructive ones like DELETE /{module}/{record_id} are excluded unless you add them.