Articles in this section

Available SugarCRM APIs

When you configure an export, import, or other type of flow step using the prebuilt SugarCRM connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the SugarCRM API documentation. *You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Activities

Activities on the home page

X

Administration

[admin] elasticsearch index statistics

X

[admin] elasticsearch mapping

X

[admin] elasticsearch queue statistics

X

[admin] elasticsearch index refresh interval status

X

[admin] elasticsearch index replica status

X

[admin] elasticsearch index routing

X

Lists filtered user records

X

[admin] search status

X

[admin] fetch auth settings

X

[admin] search field configuration

X

Currencies

Returns a collection of currency models

X

Emails

Lists filtered emails.

X

Counts related emails

X

Retrieves an emails record

X

Employees

Gets all employees

X

Expressionengine

Retrieve a forecasting information in sugarchart format

X

Forecastmanagerworksheets

Returns a collection of forecastmanagerworksheet models

X

Returns the managerworksheets at a given timeperiod

X

Returns the managerworksheets for a user at a given timeperiod

X

Forecasts

Updates a record of a specified type as a favorite for the current user.

X

Forecastsapi timeperiod filter info

X

Forecastsapi - init

X

Forecastsapi reportees

X

Projected manager data

X

Projected rep data

X

Forecastsquotasapi

X

Returns quota information for a specific user id

X

Retrieve a forecasting information in sugarchart format

X

Forecastsapi - user

X

Forecastworksheets

Returns a collection of forecastworksheet models

X

Returns the worksheets at a given timeperiod

X

Returns the worksheets for a user at a given timeperiod

X

Mail

Finds recipients that match the search term

X

Notifications

List all notifications

X

Outboundemailconfiguration

Lists the current user's outbound email configurations for sending email

X

Theme

Fetches the customizable variables of a theme

X

Kbcontents

List all kbcontents

X

Collection

List all collections from multiple modules at a time

X

Connectors

Gets general info about connectors

X

Responds with twitter timeline if connector is set up in administration

X

Responds with twitter timeline by twitterid

X

Pmse_business_rules

List all pmse_business_rules

X

Pmse_emails_templates

List all pmse_emails_templates

X

Get the variable list for a module

X

Get the related module list for a module

X

Pmse_inbox

List all pmse_inboxes

X

Retrieve settings for the pa engine

X

Retrieves the processes to show on unattended process view

X

Retrieve information of the process record

X

Returns the notes list for a process

X

Retrieve information to reassign processes

X

Returns a list with the processes for process management

X

Pmse_project

Retrieves the definition data for an activity

X

Retrieves information about fields modules roles

X

Retrieves the definition data for an event

X

Retrieves the definition data for a gateway

X

Lists pmse_project records

X

Retrieves the schema data to be used by the process definition designer

X

Verifies whether the process definition has any pending processes

X

Updates information about fields modules roles

X

Updates the definition data for an event

X

Updates the definition data for a gateway

X

Claims the processes to the current user

X

Updates the schema data from the process definition designer

X

Evaluates the response of the user form show process

X

Update settings for the advanced workflow engine

X

Call methods to reassign processes

X

Deletes a process note

X

Modules

Activities on a module's list view

X

Counts related module's

X

Retrieves a record

X

Retrieves next sibling of selected record

X

Retrieves parent node for selected record

X

Retrieves all parents of selected record

X

Returns personally identifiable information (pii) fields

X

Retrieves previous sibling of selected record

X

Retrieves previous sibling of selected record(tree)

X

Returns data changes for a specific record

X

Retrieves all children of selected record

X

Activities on a module's list view

X

Lists history filtered records

X

Lists related filtered records

X

Retrieves a related record with relationship role information

X

Counts related filtered records

X

Lists related records from multiple links at a time

X

Counts related records from multiple links at a time.

X

An api to return record list data

X

Global search

X

List all modules

X

Create a new record of a specified type

X

Append new node to target node as last child

X

Creates relationships to pre-existing record from a record list

X

Creates a relationship to a pre-existing record

X

Creates a related record

X

Creates relationships to a pre-existing record

X

Runs a duplicate check against specified data

X

Insert new node after target node

X

Insert new node before target node

X

Append new node to target node as first child

X

Delete a record of a specified type

X

Deletes an existing relationship between two records

X

Update a record of the specified type

X

Removes a record of a specified type as a favorite for the current user

X

Updates relationship specific information on an existing relationship

X

Move existing node after target node

X

Move existing node before target node

X

Move existing node as first child of target node

X

Move existing node as last child of target node

X

An api to create and save lists of records.

X

An api to delete lists of records

X

Removes a record of a specified type as a favorite for the current user

X

Updates a record of a specified type as a favorite for the current user

X

Teams

Runs a duplicate check against specified data

X

Creates a relationship to a pre-existing record

X

Deletes an existing relationship between two records

X

Revenuelineitems

Convert a revenue line item to a quote

X

Convert multiple revenue line item to a quote

X

Outboundemail

Create a new outboundemail configuration to use to send emails over smtp

X

Update an outboundemail configuration

X

Pmse_inbox

Call methods to cancel a process

X

Clear the pmse.log file log

X

Claims the processes to the current user

X

Evaluates the response of the user form show process

X

Update settings for the advanced workflow engine

X

Call methods to reassign processes

X

Deletes a process note

X

Tags

Update a record of the specified type

X

Theme

Create theme

X

Producttemplates

Producttemplate api

X

List all producttemplates

X

Timeperiods

List all timeperiods

X

Get the get the current timeperiod

X

Return a timeperiod by a given date

X

Pdfmanager

List all pdfmanagers

X

Administration

[admin] elasticsearch enable refresh_interval

X

[admin] elasticsearch trigger explicit index refresh on all indices

X

[admin] elasticsearch enable replicas

X

[admin] disable idm migrations

X

[admin] enable idm migrations

X

[admin] turn idm-mode on

X

Emailaddresses

Create a new email address

X

Update an existing email address

X

Forecastmanagerworksheets

Assign quotas to all reporting users for a given timeperiod

X

Forecastworksheets

Saves a collection of forecastworksheet models

X

Kbcontents

Runs a duplicate check against specified data

X

Creates relationships to a pre-existing record

X

Vote for knowledge base article(notuseful)

X

Vote for knowledge base article(useful)

X

Users

List all users

X

Get a user's freebusy schedule

X

Creates relationships to a pre-existing record

X

Creates relationships to a pre-existing record by remote id

X

Delete a user and return its id

X

Deletes an existing relationship between two records

X

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.