> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SugarCRM

> How to set up the SugarCRM connector, plus the actions that are available.

![SugarCRM](https://stackone-logos.com/api/sugarcrm/filled/svg)

Betav1.1.0[See changelog](https://docs.stackone.com/connectors/sugarcrm/changelog.md)

[47 actions](#actions) · 1 auth method

CRM
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 (Password Grant) · Connector Profile](https://docs.stackone.com/connectors/sugarcrm/guides/connector-profile/oauth-2-0-password-grant.md)
>
> Uses OAuth 2.0 Resource Owner Password Credentials grant. Requires a Sugar username, password, and instance URL. Tokens...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 (Password Grant) · Link Account](https://docs.stackone.com/connectors/sugarcrm/guides/link-account/oauth-2-0-password-grant.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

47 actions

ActionDescription

Get Current User`sugarcrm_get_current_user`

Retrieve the currently authenticated user's profile information

List Users`sugarcrm_list_users`

Retrieve a paginated list of users from SugarCRM

Get User`sugarcrm_get_user`

Retrieve a single user by ID

Search Records`sugarcrm_search_records`

Perform a global search across all SugarCRM modules

List Contacts`sugarcrm_list_contacts`

Retrieve a paginated list of contacts from SugarCRM

Get Contact`sugarcrm_get_contact`

Retrieve a single contact by ID

Create Contact`sugarcrm_create_contact`

Create a new contact in SugarCRM

Update Contact`sugarcrm_update_contact`

Update an existing contact in SugarCRM

Delete Contact`sugarcrm_delete_contact`

Delete a contact from SugarCRM by ID

List Accounts`sugarcrm_list_accounts`

Retrieve a paginated list of accounts from SugarCRM

Get Account`sugarcrm_get_account`

Retrieve a single account by ID

Create Account`sugarcrm_create_account`

Create a new account in SugarCRM

Update Account`sugarcrm_update_account`

Update an existing account in SugarCRM

Delete Account`sugarcrm_delete_account`

Delete an account from SugarCRM by ID

List Leads`sugarcrm_list_leads`

Retrieve a paginated list of leads from SugarCRM

Get Lead`sugarcrm_get_lead`

Retrieve a single lead by ID

Create Lead`sugarcrm_create_lead`

Create a new lead in SugarCRM

Update Lead`sugarcrm_update_lead`

Update an existing lead in SugarCRM

Delete Lead`sugarcrm_delete_lead`

Delete a lead from SugarCRM by ID

List Opportunities`sugarcrm_list_opportunities`

Retrieve a paginated list of opportunities from SugarCRM

Get Opportunity`sugarcrm_get_opportunity`

Retrieve a single opportunity by ID

Create Opportunity`sugarcrm_create_opportunity`

Create a new opportunity in SugarCRM

Update Opportunity`sugarcrm_update_opportunity`

Update an existing opportunity in SugarCRM

Delete Opportunity`sugarcrm_delete_opportunity`

Delete an opportunity from SugarCRM by ID

List Notes`sugarcrm_list_notes`

Retrieve a paginated list of notes from SugarCRM

Get Note`sugarcrm_get_note`

Retrieve a single note by ID

Create Note`sugarcrm_create_note`

Create a new note in SugarCRM

Update Note`sugarcrm_update_note`

Update an existing note in SugarCRM

Delete Note`sugarcrm_delete_note`

Delete a note from SugarCRM by ID

List Tasks`sugarcrm_list_tasks`

Retrieve a paginated list of tasks from SugarCRM

Get Task`sugarcrm_get_task`

Retrieve a single task by ID

Create Task`sugarcrm_create_task`

Create a new task in SugarCRM

Update Task`sugarcrm_update_task`

Update an existing task in SugarCRM

Delete Task`sugarcrm_delete_task`

Delete a task from SugarCRM by ID

List Calls`sugarcrm_list_calls`

Retrieve a paginated list of call records from SugarCRM

Get Call`sugarcrm_get_call`

Retrieve a single call record by ID

Create Call`sugarcrm_create_call`

Create a new call record in SugarCRM

Update Call`sugarcrm_update_call`

Update an existing call record in SugarCRM

List Meetings`sugarcrm_list_meetings`

Retrieve a paginated list of meetings from SugarCRM

Get Meeting`sugarcrm_get_meeting`

Retrieve a single meeting by ID

Create Meeting`sugarcrm_create_meeting`

Create a new meeting in SugarCRM

Update Meeting`sugarcrm_update_meeting`

Update an existing meeting in SugarCRM

List Cases`sugarcrm_list_cases`

Retrieve a paginated list of support cases from SugarCRM

Get Case`sugarcrm_get_case`

Retrieve a single support case by ID

Create Case`sugarcrm_create_case`

Create a new support case in SugarCRM

Update Case`sugarcrm_update_case`

Update an existing support case in SugarCRM

Delete Case`sugarcrm_delete_case`

Delete a support case from SugarCRM by ID


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.