SugarCRM

Manage accounts, contacts, and opportunities in SugarCRM via its REST v11 API.

This tool lists, reads, and creates records in any SugarCRM module. It performs the OAuth2 password-grant token exchange itself, so you only supply the instance credentials once — no separate login step.

What it does

• list_records — list/filter records of a module (GET /rest/v11/{module})
• get_record — fetch a single record by id (GET /rest/v11/{module}/{id})
• create_record — create a new record (POST /rest/v11/{module})

Every call is authenticated by an access token that the tool obtains via POST /rest/v11/oauth2/token (grant_type=password) and then sends in the OAuth-Token request header — exactly as the Sugar Developer Guide specifies.

apiKey setup

SugarCRM's REST login is a username/password OAuth2 exchange against your own instance, so the apiKey input packs everything needed as a pipe-delimited string:

siteUrl|username|password

Optionally append a custom OAuth client id and secret (defaults to the built-in sugar platform client with an empty secret):

siteUrl|username|password|clientId|clientSecret

Examples:

https://acme.sugarcrm.com|admin|s3cret
https://acme.sugarcrm.com|integration_user|p4ss|my_client_id|my_client_secret

• siteUrl — your instance base URL (no trailing /rest/...), e.g. https://acme.sugarcrm.com.
• username / password — a SugarCRM user with API access. A dedicated integration user is recommended.
• clientId / clientSecret — only needed if you created a custom OAuth key under Admin → OAuth Keys; otherwise omit them.

Inputs

Outputs

• result — the raw JSON response body from SugarCRM (as a string)
• status — the HTTP status code (e.g. 200, 201)

Examples

List the 10 most recent accounts whose name starts with "A":

operation: list_records
module:    Accounts
filter:    [{"name":{"$starts":"A"}}]
fields:    id,name,website,phone_office
maxNum:    10

Read a single contact:

operation: get_record
module:    Contacts
recordId:  9c8b7a6d-1234-5678-90ab-cdef01234567
fields:    id,first_name,last_name,email1

Create an opportunity:

operation: create_record
module:    Opportunities
data:      {"name":"Acme Q3 Expansion","amount":"50000","sales_stage":"Prospecting"}

Notes

• Response bodies are capped at ~5 MB.
• A non-2xx HTTP status is still returned in result/status for list/get/create so you can inspect Sugar's error payload; a network or token-exchange failure fails the step with an error envelope.

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

• error
• result
• status

Input Properties

Every property this tool accepts, from its own tool.iml.