/pmse_Inbox/filter GET
Overview
    Returns a list of Processes by user
Summary
    This endpoint gets a list of processes by user
Request Arguments
Name
Type
Description
Required
order_by
string
How to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.
false
q
string
A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.
false
filter
string
The filter expression
false
filter_id
string
Identifier for a preexisting filter. If filter is also set, the two filters are joined with an AND
false
max_num
integer
A maximum number of records to return. Default is 20.
false
offset
integer
The number of records to skip over before records are returned. Default is 0.
false


The number of records to skip over before records are returned. Default is 0.
false
fields
string
Comma delimited list of fields to return
false
deleted
boolean
Boolean to show deleted records in the result set.
false
Response Arguments
Name
Type
Description
records
<field>:<value>
Process records
next_offset
integer
Next offset for results
Response
{
    "next_offset":-1,
    "records":
    [
        {
            "id":"839ccd22-2925-11e6-83f3-6c4008960436",
            "date_modified":"2016-06-02T17:52:55-07:00",
            "created_by":"1",
            "cas_finish_date":"",
            "assigned_user_id":"1",


"assigned_user_id":"1",
            "assigned_user_name":"Administrator",
            "assigned_user_link":
            {
                "full_name":"Administrator",
                "id":"1",
                "_acl":
                {
                    "fields":
                    {
                        "pwd_last_changed":
                        {
                            "write":"no",
                            "create":"no"
                        },
                        "last_login":
                        {
                            "write":"no",
                            "create":"no"
                        }
                    },
                    "delete":"no",
                    "_hash":"08b99a97c2e8d792f7a44d8882b5af6d"
                }
            },
            "_acl":
            {
                "fields":{}
            },


"_acl":
            {
                "fields":{}
            },
            "_module":"pmse_Project\/pmse_BpmFlow",
            "_locked_fields":[],
            "cas_id":"4",
            "act_assignment_method":"static",
            "cas_title":"PQR1",
            "pro_title":"PD1",
            "date_entered":"2016-06-02T17:52:55-07:00",
            "name":"PQR1",
            "cas_create_date":"2016-06-02T17:52:55-07:00",
            "flow_id":"839ccd22-2925-11e6-83f3-6c4008960436",


"id2":"8380e512-2925-11e6-9600-6c4008960436",
            "task_name":"Activity # 1",
            "cas_assignment_method":"static",
            "cas_sugar_module":"Accounts",
            "cas_sugar_object_id":"82d5c470-2925-11e6-a269-6c4008960436",
            "prj_id":"6e025038-2842-11e6-b4f7-6c4008960436",
            "in_time":true,
            "cas_user_id":"1",
            "prj_created_by":"1",
            "cas_user_id_full_name":"Administrator",
            "prj_user_id_full_name":"Administrator"
        },


"prj_user_id_full_name":"Administrator"
        },
    ]
}
  	Last modified: 2023-02-03 21:04:03


/<module>/append/:target POST
Overview
    Append new node to target node as last child.
Request Arguments
Name
Type
Description
Required
                module

                String

                The name of sugar module that contains a nested set data and implements the NestedSetInterface.

                True

                target

                String

                The ID of record that will be used as target to append new node

                True

Request
{
    "name" : "Children Node 1"
}
Response Arguments
    This endpoint does not return any response arguments.
Response
This endpoint returns a newly created bean
    {
        "my_favorite":false,
        "following":"",
        "id":"59fa8dd7-0f2c-4bfd-364f-54495f77fa3f",


"name":"Default title",
        "date_entered":"2014-10-23T23:03:22+03:00",
        "date_modified":"2014-10-23T23:03:22+03:00",
        "modified_user_id":"1",
        "modified_by_name":"Administrator",
        "created_by":"1",
        "created_by_name":"Administrator",
        "doc_owner":"",
        "description":"",
        "deleted":false,
        "source_id":"",
        "source_type":"",
        "source_meta":"",
        "root":"be9b0c4a-8b78-1ffa-4f14-54481c2f6269",
        "lft":118,
        "rgt":119,


"lft":118,
        "rgt":119,
        "level":1,
        "_acl":{"fields":{}},
        "_module":"Categories"
    }
Change Log
Version
Change
            v10

            Added /<module>/append/:target POST endpoint.

  	Last modified: 2023-02-03 21:04:03


/Administration/elasticsearch/indices GET
Overview
    [ADMIN] Elasticsearch index statistics
Summary
    This endpoint returns the index statistics for the Elasticsearch backend. This endpoint is only available to
    administrators.
Response
{
    "autobr2583_shared":{
        "_shards":{
            "total":1,
            "successful":1,
            "failed":0
        },
        "indices":{
            "autobr2583_shared":{
                "index":{
                    "primary_size_in_bytes":1134148,
                    "size_in_bytes":1134148
                },
                "translog":{
                    "operations":1100
                },
                "docs":{
                    "num_docs":1100,
                    "max_doc":1100,
                    "deleted_docs":0


"max_doc":1100,
                    "deleted_docs":0
                },
                "merges":{
                    "current":0,
                    "current_docs":0,
                    "current_size_in_bytes":0,
                    "total":1,
                    "total_time_in_millis":103,
                    "total_docs":1000,
                    "total_size_in_bytes":1138070
                },
                "refresh":{
                    "total":13,
                    "total_time_in_millis":177
                },
                "flush":{
                    "total":0,
                    "total_time_in_millis":0
                },
                "shards":[[{
                    "routing":{
                        "state":"STARTED",
                        "primary":true,


"state":"STARTED",
                        "primary":true,
                        "node":"4rjVEVuYQQqKl4sT1FUxNA",
                        "relocating_node":null,
                        "shard":0,
                        "index":"autobr2583_shared"
                    },
                    "state":"STARTED",
                    "index":{
                        "size_in_bytes":1134148
                    },
                    "translog":{
                        "id":1427003304006,
                        "operations":1100
                    },
                    "docs":{
                        "num_docs":1100,
                        "max_doc":1100,
                        "deleted_docs":0
                    },
                    "merges":{
                        "current":0,
                        "current_docs":0,


"current":0,
                        "current_docs":0,
                        "current_size_in_bytes":0,
                        "total":1,
                        "total_time_in_millis":103,
                        "total_docs":1000,
                        "total_size_in_bytes":1138070
                    },
                    "refresh":{
                        "total":13,
                        "total_time_in_millis":177
                    },
                    "flush":{
                        "total":0,
                        "total_time_in_millis":0
                    }
                }]]
            }
        }
    }
}
Change Log
Version
Change
            v10

            Added /Administration/elasticsearch/indices GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/<module> POST
Overview
    Create a new record of a specified type.
Request Arguments
Name
Type
Description
Required
                <record field>

                <record field type>

                The name value list of fields to populate.

                True

Request
{
    "name":"Example Account",
    "account_type":"Customer",
    "description":"My Example Account",
    "meetings": {
    {
        "add": ["21e3385e-404f-b470-407e-54044e3d8023"],
        "create": [
        {
            "name": "Test Meeting"
        }
      ]
    }
  }
}
Link fields
    It is possible to add record relations to other records and create new related records.
Action
Type
Description
add
            List


Action
Type
Description
add
            List

            List of related records ID. See RelateRecordApi
            for details.

create
            List

            List of name to value arrays of related records.

Response Arguments
Name
Type
Description
                <record field>

                <record field type>

                Returns the fields for the newly created record.

Response
{
   "id":"e91b1fa7-1bd8-3c71-be96-512e643f9ca4",
   "name":"Example Account",
   "date_entered":"2013-02-27T19:56:00+00:00",
   "date_modified":"2013-02-27T19:56:00+00:00",
   "modified_user_id":"1",


"modified_user_id":"1",
   "modified_by_name":"Administrator",
   "created_by":"1",
   "created_by_name":"Administrator",
   "description":"My Example Account",
   "img":"",
   "deleted":false,
   "assigned_user_id":"",
   "assigned_user_name":"",
   "team_name":[
      {
         "id":1,
         "name":"Global",
         "name_2":"",
         "primary":true
      }
   ],
   "linkedin":"",
   "facebook":"",
   "twitter":"",
   "googleplus":"",
   "account_type":"Customer",
   "industry":"",
   "annual_revenue":"",
   "phone_fax":"",


"annual_revenue":"",
   "phone_fax":"",
   "billing_address_street":"",
   "billing_address_street_2":"",
   "billing_address_street_3":"",
   "billing_address_street_4":"",
   "billing_address_city":"",
   "billing_address_state":"",
   "billing_address_postalcode":"",
   "billing_address_country":"",
   "rating":"",
   "phone_office":"",
   "phone_alternate":"",
   "website":"",
   "ownership":"",
   "employees":"",
   "ticker_symbol":"",
   "shipping_address_street":"",
   "shipping_address_street_2":"",


"shipping_address_street_2":"",
   "shipping_address_street_3":"",
   "shipping_address_street_4":"",
   "shipping_address_city":"",
   "shipping_address_state":"",
   "shipping_address_postalcode":"",
   "shipping_address_country":"",
   "email1":"",
   "parent_id":"",
   "sic_code":"",
   "parent_name":"",
   "email_opt_out":"",
   "invalid_email":"",
   "email":[
   ],
   "campaign_id":"",
   "campaign_name":"",
   "my_favorite":false,
   "_acl":{
      "fields":{
      }
   }
}
Change Log
Version
Change


}
   }
}
Change Log
Version
Change
            v10 (7.6.0)

            Added support for link fields.

            v10

            Added /<module> POST endpoint.

  	Last modified: 2023-02-03 21:04:03


/<module>/Activities GET
Activities on a module's list view
Summary:
  This endpoint lists activities across a particular module in the system. It uses a subscription model, and can be queried like a normal bean collection, but without search, ordering or filtering.
Query Parameters:
ParamDescriptionOptionalmax_numA maximum number of records to returnOptionaloffsetHow many records to skip over before records are returnedOptional
Input Example:
This endpoint does not accept any input
Output Example:
{
    "next_offset": 20, This will be set to -1 when there are no more records after this "page".
    "records": [{
        "id": "22fb8b16-de1d-f1dc-b15b-51240efde177",
        "date_entered": "2013-02-19T23:47:11+00:00",


"date_modified": "2013-02-19T23:47:11+00:00",
        "created_by": "1",
        "deleted": "0",
        "parent_id": "f5bb0331-2c0f-5c7c-b4db-5123caac0056",
        "parent_type": "Contacts",
        "activity_type": "post", This will be the type of activity performed.
        "data": {
            "value": "This is a test post on a contact I'm subscribed to."
        },
        "comment_count": 0, This will be set to the total number of comments on the post.
        "last_comment": { This will be the last comment on the post, which can be used to create a comment model on the frontend.
            "deleted": 0,


"deleted": 0,
            "data": []
        },
        "fields": [],
        "first_name": null,
        "last_name": "Administrator",
        "created_by_name": " Administrator" This will be the locale-formatted full name of the user.
    }, ... ]
}
  	Last modified: 2023-02-03 21:04:03


/Administration/elasticsearch/replicas/status GET
Overview
    [ADMIN] Elasticsearch index replica status
Summary
    This endpoint returns the number of replicas for every index managed by SugarCRM. This endpoint is only
    available to administrators.
Response
{
  "aabbcc_contactsleads": "4",
  "aabbcc_accountsonly": "2",
  "aabbcc_shared": "1"
}
Change Log
Version
Change
            v10

            Added /Administration/elasticsearch/replicas/status GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/Administration/portalmodules GET
Overview
[ADMIN] Gets an array of modules currently enabled for Sugar Portal.
Summary
This endpoint gets an array of modules currently enabled for Sugar Portal. This endpoint is only available to administrators.
Request Arguments
This endpoint does not accept any arguments.
Response Example
[
    'Home',
    'Bugs',
    'Cases',
    'KBContents',
]
Change Log
Version
Change
v11.13
AddedÂ Administration/portalmodulesÂ GET endpoint
  	Last modified: 2023-02-03 21:04:03


/Reports/:record/record_count GET
Overview
    An API to get total number of filtered records from a saved report.
Summary
    This endpoint will return total number of records from a saved report filtered by an expression.
Request Arguments
Name
Type
Description
Required
            group_filters

            String

            The group filter expression. Filter expressions are explained below.
            Note that JSON-encoded filters can be specified as query parameters
            in one of two ways for GET requests:

                    By specifying individual filter arguments as distinct parameters.
                    Example: group_filters[0][name]=value.

                    By specifying the whole filter as a single JSON-encoded string.
                    Example: group_filters=[{"name":"value"}].

            Example: group_filters[0][industry]=Engineering.

            False


False

            use_saved_filters

            Boolean

            Flag to indicate whether or not to apply saved runtime filters if exists. The default value is false.
            Example: use_saved_filters=true.

            False

Request Example
GET /rest/v10/Reports/:id/record_count?group_filters[0][industry]=Engineering
Response Arguments
Name
Type
Description
            record_count

            Integer

            Total number of filtered records.

Response
{
   "record_count": 5
}
  	Last modified: 2023-02-03 21:04:03


/Emails POST
Overview
    Create a new Emails record.
Summary
    Used for creating an archived email, creating a draft to send later, or creating and sending an email.
Creating an Archived Email
Request Arguments
Name
Type
Description
Required
                state

                String

                Use "Archived" to create an archived email. "Archived" is the default value if this argument is not
                provided.

                False

                name

                String

                The email's subject.

                False

                description_html

                String

                The email's HTML body.

                False

                description

                String

                The email's plain text body. This field is not necessary unless the text body is different from the HTML
                body.

                False


body.

                False

                raw_source

                String

                The complete raw source of the email showing the headers and content in one document.

                False

                date_sent

                String

                The date that the email was sent/received.

                False

                message_id

                String

                The email's unique identifier.

                False

                message_uid

                String

                Only use this field for importing emails downloaded from an IMAP server, as this is the email's IMAP
                UID.

                False

                assigned_user_id

                String

                The assigned user's ID.

                False

                parent_type

                String


False

                parent_type

                String

                The parent record's module.

                False

                parent_id

                String

                The parent record's ID.

                False

                team_name

                List

                List of teams that can access the email.

                False

                from

                Object

                The email's sender. Existing EmailParticipants records cannot be used; only the create action is
                supported. Metadata about the sender is required to link the record.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the sender.


for the sender.

email_address_id is the ID of the email address the sender used to send the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                True

                to

                Object

                The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.


for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                cc

                Object

                The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.


for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                bcc

                Object

                The email's recipients found in the BCC field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.


for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                attachments

                Object

                The email's attachments. Existing Notes records cannot be used as email attachments; only the
                create action is supported. Metadata about each attachment is required to link the records.

filename_guid is the temporary file ID for an uploaded file to attach as a Notes record.

upload_id is the ID of an existing file that the Notes record should reference as the
                        attachment. This allows files to be shared by multiple Notes records, to preserve space.


When using upload_id, file_source should be provided to indicate from where the
                        file originated. The value should be the module of the record that shares its ID with the file.
                        So when an attachment comes from an email template, file_source should be
                        EmailTemplates. And when an attachment comes from a document, file_source should
                        be DocumentRevisions.

                False

Request
{
  "state": "Archived",
  "name": "Re: Discuss Proposal",
  "description": "Now is a good time",
  "description_html": "
Now is a good time
",
  "date_sent": "2012-02-17T06:53:00-08:00",


"message_id": "<d9c165d0-8863-ba61-dc85-51ed8016c476@example.com>",
  "assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "parent_type": "Leads",
  "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6",
  "team_name": [{
    "id": "1",
    "display_name": "Global",
    "name": "Global",
    "name_2": "",
    "primary": true,
    "selected": false
  }],
  "from": {
    "create": [{


}],
  "from": {
    "create": [{
      "parent_type": "Leads",
      "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
    }]
  },
  "to": {
    "create": [{
      "parent_type": "Users",
      "parent_id": "9c61c46a-a7c5-df71-481c-51d48232f820"
    }]
  },
  "cc": {
    "create": [{
      "parent_type": "Contacts",
      "parent_id": "79b9c194-7d79-11e7-8fc5-3c15c2d582c6"
    }, {


}, {
      "parent_type": "Users",
      "parent_id": "79c2e800-7d79-11e7-84af-3c15c2d582c6"
      "email_address_id": "79cc341e-7d79-11e7-8748-3c15c2d582c6"
    }]
  },
  "bcc": {
    "create": [{
      "email_address_id": "ac804842-7d78-11e7-a809-3c15c2d582c6"
    }]
  },
  "attachments": {
    "create": [{
      "filename_guid": "afe9702e-53a3-0efb-6bbe-56c3580885ef",


"name": "Quote.pdf",
      "filename": "Quote.pdf"
    }]
  }
}
Response
{
  "id": "a028341c-ba92-9343-55e7-56cf5beda121",
  "date_entered": "2016-02-25T11:53:07-08:00",
  "created_by": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "created_by_name": "Sarah Smith",
  "date_modified": "2016-02-25T11:53:07-08:00",
  "modified_by_name": "Sarah Smith",


"modified_by_name": "Sarah Smith",
  "modified_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "deleted": false,
  "assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "assigned_user_name": "Sarah Smith",
  "state": "Archived",
  "name": "Re: Discuss Proposal",
  "description": "Now is a good time",
  "description_html": "
Now is a good time
",
  "date_sent": "2012-02-17T06:53:00-08:00",
  "message_id": "",
  "message_uid": "",


"message_id": "",
  "message_uid": "",
  "reply_to_status": false,
  "total_attachments": 1,
  "parent_name": "Tom Davis",
  "parent_type": "Leads",
  "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
  "team_count": "",
  "team_name": [{
    "id": 1,
    "name": "Global",
    "name_2": "",
    "primary": true,
    "selected": false
  }],
  "my_favorite": false,
  "_acl": {
    "fields": {}
  },
  "_module": "Emails"
}
Creating a Draft
Request Arguments


"_module": "Emails"
}
Creating a Draft
Request Arguments
Name
Type
Description
Required
                state

                String

                Use "Draft" to save a draft.

                True

                outbound_email_id

                String

                The ID of the chosen SMTP configuration for sending an email. Only use this field when saving a draft
                or sending an email. The user's default SMTP configuration is used if one hasn't been chosen prior to
                sending.

                False

                name

                String

                The email's subject.

                False

                description_html

                String

                The email's HTML body.

                False

                description

                String


False

                description

                String

                The email's plain text body. This field is not necessary unless the text body is different from the HTML
                body.

                False

                reply_to_id

                String

                Only use this field when saving a draft or sending an email that is a reply to another email. This is
                the ID of that other email.

                False

                parent_type

                String

                The parent record's module.

                False

                parent_id

                String

                The parent record's ID.

                False

                to

                Object

                The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only


the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                cc

                Object

                The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.


the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                bcc

                Object

                The email's recipients found in the BCC field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.


the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get
                        the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                attachments

                Object

                The email's attachments. Existing Notes records cannot be used as email attachments; only the
                create action is supported. Metadata about each attachment is required to link the records.


filename_guid is the temporary file ID for an uploaded file to attach as a Notes record.

upload_id is the ID of an existing file that the Notes record should reference as the
                        attachment. This allows files to be shared by multiple Notes records, to preserve space.

                        When using upload_id, file_source should be provided to indicate from where the
                        file originated. The value should be the module of the record that shares its ID with the file.
                        So when an attachment comes from an email template, file_source should be
                        EmailTemplates. And when an attachment comes from a document, file_source should
                        be DocumentRevisions.

                False

Request
{
  "state": "Draft",


False

Request
{
  "state": "Draft",
  "outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
  "name": "Re: Discuss Proposal",
  "description_html": "
Calling you now.
",
  "reply_to_id": "a028341c-ba92-9343-55e7-56cf5beda121",
  "parent_type": "Leads",
  "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6",
  "to": {
    "create": [{
      "parent_type": "Leads",


"create": [{
      "parent_type": "Leads",
      "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
    }]
  },
  "cc": {
    "create": [{
      "parent_type": "Contacts",
      "parent_id": "79b9c194-7d79-11e7-8fc5-3c15c2d582c6"
    }, {
      "parent_type": "Users",
      "parent_id": "79c2e800-7d79-11e7-84af-3c15c2d582c6"


"email_address_id": "79cc341e-7d79-11e7-8748-3c15c2d582c6"
    }]
  },
  "bcc": {
    "create": [{
      "email_address_id": "ac804842-7d78-11e7-a809-3c15c2d582c6"
    }]
  },
  "attachments": {
    "create": [{
      "upload_id": "a028341c-ba92-9343-55e7-56cf5beda121",
      "name": "Contract.pdf",
      "filename": "Contract.pdf",
      "file_source": "DocumentRevisions"
    }, {


"file_source": "DocumentRevisions"
    }, {
      "upload_id": "18a72782-4514-11e6-a5f7-3c15c2d582c6",
      "name": "survey.doc",
      "filename": "survey.doc",
      "file_source": "EmailTemplates"
    }]
  }
}
Response
{
  "id": "f3c85966-7d27-11e7-9e9e-3c15c2d582c6",
  "date_entered": "2016-02-25T11:53:07-08:00",
  "created_by": "9c61c46a-a7c5-df71-481c-51d48232f820",


"created_by_name": "Sarah Smith",
  "date_modified": "2016-02-25T11:53:07-08:00",
  "modified_by_name": "Sarah Smith",
  "modified_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "deleted": false,
  "assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "assigned_user_name": "Sarah Smith",
  "state": "Draft",
  "outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",


"name": "Re: Discuss Proposal",
  "description": "Now is a good time",
  "description_html": "
Now is a good time
",
  "date_sent": "2012-02-17T11:53:07-08:00",
  "message_id": "",
  "message_uid": "",
  "reply_to_id": "a028341c-ba92-9343-55e7-56cf5beda121",
  "reply_to_status": false,
  "total_attachments": 2,
  "parent_name": "Tom Davis",
  "parent_type": "Leads",
  "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"


"team_count": "",
  "team_name": [{
    "id": 1,
    "name": "Global",
    "name_2": "",
    "primary": true,
    "selected": false
  }],
  "my_favorite": false,
  "_acl": {
    "fields": {}
  },
  "_module": "Emails"
}
Sending an Email
Request Arguments
Name
Type
Description
Required
                state

                String

                Use "Ready" to send an email.

                True

                outbound_email_id

                String

                The ID of the chosen SMTP configuration for sending an email. Only use this field when saving a draft


or sending an email. The user's default SMTP configuration is used if one hasn't been chosen prior to
                sending.

                False

                name

                String

                The email's subject.

                False

                description_html

                String

                The email's HTML body.

                False

                description

                String

                The email's plain text body. This field is not necessary unless the text body is different from the HTML
                body.

                False

                reply_to_id

                String

                Only use this field when saving a draft or sending an email that is a reply to another email. This is
                the ID of that other email.

                False

                parent_type

                String


False

                parent_type

                String

                The parent record's module.

                False

                parent_id

                String

                The parent record's ID.

                False

                to

                Object

                The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get


the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                cc

                Object

                The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get


the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                bcc

                Object

                The email's recipients found in the BCC field. Existing EmailParticipants records cannot be used; only
                the create action is supported. Metadata about each recipient is required to link the records.

parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
                        or Users, out out of the box. These fields are not necessary if only an email address is known
                        for the recipient.

email_address_id is the ID of the email address the recipient used in the email. To get


the ID of the email address, first make a request to /EmailAddresses POST. If this
                        argument is not provided, then the primary email address of the parent record is used.

                False

                attachments

                Object

                The email's attachments. Existing Notes records cannot be used as email attachments; only the
                create action is supported. Metadata about each attachment is required to link the records.

filename_guid is the temporary file ID for an uploaded file to attach as a Notes record.

upload_id is the ID of an existing file that the Notes record should reference as the
                        attachment. This allows files to be shared by multiple Notes records, to preserve space.

                        When using upload_id, file_source should be provided to indicate from where the


When using upload_id, file_source should be provided to indicate from where the
                        file originated. The value should be the module of the record that shares its ID with the file.
                        So when an attachment comes from an email template, file_source should be
                        EmailTemplates. And when an attachment comes from a document, file_source should
                        be DocumentRevisions.

                False

Request
{
  "state": "Ready",
  "outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
  "name": "Discuss Proposal",
  "description_html": "
When is a good time for us to chat?
",
  "parent_type": "Leads",


"parent_type": "Leads",
  "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6",
  "to": {
    "create": [{
      "parent_type": "Leads",
      "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
    }]
  },
  "cc": {
    "create": [{
      "parent_type": "Users",
      "parent_id": "79c2e800-7d79-11e7-84af-3c15c2d582c6"


"email_address_id": "79cc341e-7d79-11e7-8748-3c15c2d582c6"
    }]
  },
  "attachments": {
    "create": [{
      "upload_id": "a028341c-ba92-9343-55e7-56cf5beda121",
      "name": "Contract.pdf",
      "filename": "Contract.pdf",
      "file_source": "DocumentRevisions"
    }, {
      "upload_id": "18a72782-4514-11e6-a5f7-3c15c2d582c6",
      "name": "survey.doc",
      "filename": "survey.doc",
      "file_source": "EmailTemplates"
    }]
  }


"file_source": "EmailTemplates"
    }]
  }
}
Response
{
  "id": "a7795664-7def-11e7-8add-3c15c2d582c6",
  "date_entered": "2016-02-25T08:53:07-08:00",
  "created_by": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "created_by_name": "Sarah Smith",
  "date_modified": "2016-02-25T08:53:07-08:00",
  "modified_by_name": "Sarah Smith",
  "modified_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",


"deleted": false,
  "assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
  "assigned_user_name": "Sarah Smith",
  "state": "Archived",
  "outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
  "name": "Discuss Proposal",
  "description": "When is a good time for us to chat?",
  "description_html": "
When is a good time for us to chat?
",
  "date_sent": "2012-02-17T08:53:07-08:00",


"message_id": "<a7795664-7def-11e7-8add-3c15c2d582c6@example.com>",
  "message_uid": "",
  "reply_to_id": "",
  "reply_to_status": false,
  "total_attachments": 2,
  "parent_name": "Tom Davis",
  "parent_type": "Leads",
  "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
  "team_count": "",
  "team_name": [{
    "id": 1,
    "name": "Global",
    "name_2": "",
    "primary": true,
    "selected": false
  }],


"primary": true,
    "selected": false
  }],
  "my_favorite": false,
  "_acl": {
    "fields": {}
  },
  "_module": "Emails"
}
Change Log
Version
Change
            v10

            Added /Emails POST endpoint.

  	Last modified: 2023-02-03 21:04:03


/<module>/favorites GET
Overview
    Opportunity Favorites Help
Summary
    This endpoint returns all the favorite Quotes/Revenue Line Items in alphabetical order to be displayed in the
    "Product Catalog Quick Picks" dashlet.
Request Arguments
Name
Type
Description
Required
            pageNum

            integer

            An integer attribute in the payload data object which gets the page number for which the items need to be
            displayed based on the current page or the page clicked.

            False

Request
{
    pageNum: 0
}
Response Arguments
Name
Type
Description
            <config field>

            <config field type>

            The list of config fields will be returned.

Response
{
    "totalPages":5,
    "pageNum":0,
    "max_num":8,


"pageNum":0,
    "max_num":8,
    "records":[
                {
                    "id":"c181bd32-c7f2-11e8-b4eb-7831c1c14620",
                    "name":"Allyson Gadget",
                    "date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",


"category_id":"c18112d8-c7f2-11e8-b753-7831c1c14620",
                    "mft_part_num":"Ink Conglomerate Inc 921535XYZ987",
                    "vendor_part_num":null,
                    "date_cost_price":null,
                    "cost_price":"534.000000",
                    "discount_price":"842.000000",
                    "list_price":"905.000000",
                    "cost_usdollar":"534.000000",
                    "discount_usdollar":"842.000000",
                    "list_usdollar":"905.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,


"website":null,
                    "weight":"20.00",
                    "qty_in_stock":26,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,
                    "pricing_formula":"Fixed",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                },
                {
                    "id":"c18e0448-c7f2-11e8-86b0-7831c1c14620",
                    "name":"Arla Gadget",
                    "date_entered":"2018-10-04 16:28:37",


"date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
                    "category_id":"c18b8b64-c7f2-11e8-8c1a-7831c1c14620",
                    "mft_part_num":"24\/7 Couriers 795391XYZ987",
                    "vendor_part_num":null,
                    "date_cost_price":null,


"date_cost_price":null,
                    "cost_price":"398.000000",
                    "discount_price":"402.020202",
                    "list_price":"941.000000",
                    "cost_usdollar":"398.000000",
                    "discount_usdollar":"402.020202",
                    "list_usdollar":"941.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,
                    "weight":"22.00",
                    "qty_in_stock":145,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,
                    "pricing_formula":"ProfitMargin",


"pricing_formula":"ProfitMargin",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                },
                {
                    "id":"c1b60434-c7f2-11e8-8964-7831c1c14620",
                    "name":"Billie Gadget",
                    "date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,
                    "type_id":null,


"deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
                    "category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
                    "mft_part_num":"Kringle Bell IncK.A. Tower \u0026 Co 694143XYZ987",
                    "vendor_part_num":null,
                    "date_cost_price":null,
                    "cost_price":"403.000000",
                    "discount_price":"927.000000",
                    "list_price":"927.000000",
                    "cost_usdollar":"403.000000",


"cost_usdollar":"403.000000",
                    "discount_usdollar":"927.000000",
                    "list_usdollar":"927.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,
                    "weight":"16.00",
                    "qty_in_stock":148,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,
                    "pricing_formula":"IsList",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                },
                {


"base_rate":"1.000000"
                },
                {
                    "id":"c186a612-c7f2-11e8-9fee-7831c1c14620",
                    "name":"Bradford Gadget",
                    "date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",


"category_id":"c185dbb0-c7f2-11e8-a6b7-7831c1c14620",
                    "mft_part_num":"Mississippi Bank Group 133834XYZ987",
                    "vendor_part_num":null,
                    "date_cost_price":null,
                    "cost_price":"528.000000",
                    "discount_price":"533.333333",
                    "list_price":"745.000000",
                    "cost_usdollar":"528.000000",
                    "discount_usdollar":"533.333333",
                    "list_usdollar":"745.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,
                    "weight":"33.00",


"website":null,
                    "weight":"33.00",
                    "qty_in_stock":70,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,
                    "pricing_formula":"ProfitMargin",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                },
                {
                    "id":"c1b4680e-c7f2-11e8-9380-7831c1c14620",
                    "name":"Brain Gadget",
                    "date_entered":"2018-10-04 16:28:37",


"date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
                    "category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
                    "mft_part_num":"Smallville Resources Inc 362299XYZ987",
                    "vendor_part_num":null,
                    "date_cost_price":null,


"date_cost_price":null,
                    "cost_price":"370.000000",
                    "discount_price":"854.370000",
                    "list_price":"863.000000",
                    "cost_usdollar":"370.000000",
                    "discount_usdollar":"854.370000",
                    "list_usdollar":"863.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,
                    "weight":"10.00",
                    "qty_in_stock":106,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,
                    "pricing_formula":"PercentageDiscount",


"pricing_formula":"PercentageDiscount",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                },
                {
                    "id":"c1baf0e8-c7f2-11e8-ab05-7831c1c14620",
                    "name":"Carley Gadget",
                    "date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,
                    "type_id":null,


"deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
                    "category_id":"c1b8e4ec-c7f2-11e8-b435-7831c1c14620",
                    "mft_part_num":"Hollywood Diner Ltd 10023XYZ987",
                    "vendor_part_num":null,
                    "date_cost_price":null,
                    "cost_price":"554.000000",
                    "discount_price":"559.595960",
                    "list_price":"927.000000",
                    "cost_usdollar":"554.000000",
                    "discount_usdollar":"559.595959",


"discount_usdollar":"559.595959",
                    "list_usdollar":"927.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,
                    "weight":"30.00",
                    "qty_in_stock":58,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,
                    "pricing_formula":"ProfitMargin",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                },
                {


"base_rate":"1.000000"
                },
                {
                    "id":"c1b77544-c7f2-11e8-8347-7831c1c14620",
                    "name":"Carma Gadget",
                    "date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",


"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
                    "mft_part_num":"Sea Region Inc 773472XYZ987",
                    "vendor_part_num":null,
                    "date_cost_price":null,
                    "cost_price":"332.000000",
                    "discount_price":"745.000000",
                    "list_price":"822.000000",
                    "cost_usdollar":"332.000000",
                    "discount_usdollar":"745.000000",
                    "list_usdollar":"822.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,
                    "weight":"35.00",


"website":null,
                    "weight":"35.00",
                    "qty_in_stock":1,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,
                    "pricing_formula":"Fixed",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                },
                {
                    "id":"c1b98c9e-c7f2-11e8-9740-7831c1c14620",
                    "name":"Catrina Gadget",
                    "date_entered":"2018-10-04 16:28:37",


"date_entered":"2018-10-04 16:28:37",
                    "date_modified":"2018-10-04 16:28:37",
                    "modified_user_id":"1",
                    "created_by":"1",
                    "description":null,
                    "deleted":0,
                    "type_id":null,
                    "manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
                    "category_id":"c1b8e4ec-c7f2-11e8-b435-7831c1c14620",
                    "mft_part_num":"Jungle Systems Inc 273034XYZ987",
                    "vendor_part_num":null,
                    "date_cost_price":null,


"date_cost_price":null,
                    "cost_price":"577.000000",
                    "discount_price":"582.770000",
                    "list_price":"946.000000",
                    "cost_usdollar":"577.000000",
                    "discount_usdollar":"582.770000",
                    "list_usdollar":"946.000000",
                    "status":"Available",
                    "tax_class":"Taxable",
                    "date_available":"2004-10-15",
                    "website":null,
                    "weight":"13.00",
                    "qty_in_stock":105,
                    "support_name":null,
                    "support_description":null,
                    "support_contact":null,
                    "support_term":null,
                    "pricing_formula":"PercentageMarkup",


"pricing_formula":"PercentageMarkup",
                    "pricing_factor":"1.00",
                    "assigned_user_id":null,
                    "currency_id":"-99",
                    "base_rate":"1.000000"
                }
            ]
}
Change Log
Version
Change
            v10

            Added /Opportunities/favorites GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/Dashboards/<module> POST
    Create a new dashboard.
Notice
This endpoint is not supported in v11. If you continue to use v10 of the API, your
    REST calls should behave as below. But, it is advisable to upgrade to v11.Migrating to v11:
    For more information on behavior in v11, refer to POST /<module>.
    Recommended Replacement: POST /Dashboards
    The module name is no longer part of the path. To specify a module name, include it in the Request Body.
    For example, to create an Accounts module dashboard, usev11: POST /Dashboards with the following in the Request Body:
{"dashboard_module":"Accounts"}
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{


The name value list of fields to populate.
True
Request
{
    "name": "New Dashboard for Accounts Module",
    "dashboard_module": "Accounts",
    "view_name": "records",
    "metadata": {
        "components": [{
            "rows": [[{
                "view": {
                    "type": "dashablelist",
                    "label": "TPL_DASHLET_MY_MODULE",
                    "display_columns": ["name","billing_address_city"]
                },
                "context": {"module":"Accounts"},
                "width": 12
            }]],
            "width": 12
        }]
    }
}
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the newly created dashboard.
Response
{


<record field type>
Returns the fields for the newly created dashboard.
Response
{
  "id": "8f9cd3d1-ce5d-e8d4-12d8-56cf674d2600",
  "name": "New Dashboard for Accounts Module",
  "date_entered": "2016-02-25T12:44:27-08:00",
  "date_modified": "2016-02-25T12:44:27-08:00",
  "modified_user_id": "1",
  "modified_by_name": "Administrator",
  "created_by": "1",
  "created_by_name": "Administrator",
  "description": "",
  "deleted": false,
  "dashboard_module": "Accounts",


"deleted": false,
  "dashboard_module": "Accounts",
  "view_name": "records",
  "metadata": {
    "components": [
      {
        "rows": [
          [
            {
              "view": {
                "type": "dashablelist",
                "label": "TPL_DASHLET_MY_MODULE",
                "display_columns": [
                  "name",
                  "billing_address_city"
                ]
              },
              "context": {
                "module": "Accounts"
              },
              "width": 12
            }
          ]
        ],
        "width": 12
      }
    ]
  },
  "following": "",
  "my_favorite": false,
  "tag": [],


"my_favorite": false,
  "tag": [],
  "assigned_user_id": "1",
  "assigned_user_name": "Administrator",
  "_acl": {
    "fields": {}
  },
  "view": "records",
  "_module": "Dashboards"
}
Change Log
Version
Change
v11
No longer supported. Please use POST /Dashboards instead.
v10
Added /Dashboards/<module> POST endpoint.
  	Last modified: 2023-02-03 21:04:03


/ProductTemplates/tree POST
ProductTemplate API
Summary:
    This endpoint is designed to return a paged recordset of one level of product templates and product categories in
    a N-level deep tree representing the relationship between categories and templates.  The results are loosely
    filtered (wildcard before and after).
Query Parameters:
Param
Description
Optional
filter
The filter used to search Product Template and Product Category names.  %filter%
true
root
The ID of the root node you wish to retrieve.  Defaults to null (the root level)
true
offset
Specifies the numeric value of the offset you wish to retrieve
true
max_num
Specifies the numeric value of the max number of records you wish to receive. Default is 20.
true
Response Parameters:
Param
Description
id
The id of the item (Product Category/Template)
Data


Description
id
The id of the item (Product Category/Template)
Data
The name of the item
state
Specifies the open or closed state of the element. (used for categories)
index
Specifies the index of this element in the current level.
Response:
        {
            "records":[
                {
                    "id":"023d316a-d9d0-11e7-9f54-02425392a518",
                    "type":"category",
                    "data":"Christen Widgets",
                    "state":"closed",
                    "index":0
                },
                {
                    "id":"01828a4a-d9d0-11e7-8989-02425392a518",
                    "type":"category",
                    "data":"Desktops",
                    "state":"closed",
                    "index":1


"state":"closed",
                    "index":1
                }
            ],
            "next_offset":2
        }

  	Last modified: 2023-02-03 21:04:03


/<module>/:record/pii GET
Overview
    Returns personally identifiable information (pii) fields with current data and source of data capture for a specific record.
Version Requirements
    Minimum REST API Version required - 11.1
Request Arguments
Name
Type
Description
Required
            module

            String

            The name of the module.

            True

            record

            String

            The record id.

            True

Response Arguments
Name
Type
Description
            records

            String

            Returns the set of PII field records for the given module record.

Response
{
  "fields": [
    {
      "field_name": "phone_mobile",
      "value": "(645) 604-0128",
      "event_type": "update",


"event_type": "update",
      "date_modified": "2018-02-21T19:56:42+00:00",
      "source": {
        "subject": {
          "_type": "user",
          "id": "999b3b50-16dc-11e8-9c03-a45e60e64123",
          "_module": "Users",
          "client": {
            "_type": "rest-api"
          },
          "first_name": "Tim",
          "last_name": "Zhang",
          "name": "Tim Zhang"
        },
        "attributes": {
          "platform": "base"
        }
      }
    },
    {
      "field_name": "phone_work",
      "value": "(212) 692-3480",


"value": "(212) 692-3480",
      "event_type": "update",
      "date_modified": "2018-02-21T19:56:42+00:00",
      "source": {
        "subject": {
          "_type": "user",
          "id": "654b3b50-16dc-11e8-9c03-a45e60e64465",
          "_module": "Users",
          "client": {
            "_type": "rest-api"
          },
          "first_name": "Jim",
          "last_name": "Conners",
          "name": "Jim Conners"
        },
        "attributes": {
          "platform": "base"
        }
      }
    }
  ]
}
Change Log
Version
Change


}
    }
  ]
}
Change Log
Version
Change
            11.1

            Added /pii GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/metadata/<module>/:segment GET
Overview
[ADMIN] Gets the desired segment for a given module.
Summary
Gets the desired segment for a given module. This is used only for modules that are not visible and thus not in metatdata for the given context. This endpoint is only available to administrators.
Request Arguments
This endpoint does not accept any request arguments.
Response
{
    "fields": {
        Any fields associated with the module
    }
}
Change Log
Version
Change
v11_11
Added /metadata/<module>/:segmentÂ GET endpoint.
  	Last modified: 2023-02-03 21:04:03


/<module>/:record/link/activities GET
Activities on a module's list view
Summary:
  This endpoint lists activities across a particular module in the system. It does not use a subscription model unlike the other endpoints. It can be queried as a regular bean collection, but without search, ordering or filtering.
Query Parameters:
ParamDescriptionOptionalmax_numA maximum number of records to returnOptionaloffsetHow many records to skip over before records are returnedOptional
Input Example:
This endpoint does not accept any input
Output Example:
{
    "next_offset": 20, This will be set to -1 when there are no more records after this "page".
    "records": [{
        "id": "22fb8b16-de1d-f1dc-b15b-51240efde177",


"date_entered": "2013-02-19T23:47:11+00:00",
        "date_modified": "2013-02-19T23:47:11+00:00",
        "created_by": "1",
        "deleted": "0",
        "parent_id": "f5bb0331-2c0f-5c7c-b4db-5123caac0056",
        "parent_type": "Contacts",
        "activity_type": "post", This will be the type of activity performed.
        "data": {
            "value": "This is a test post on a contact I'm subscribed to."
        },
        "comment_count": 0, This will be set to the total number of comments on the post.


"last_comment": { This will be the last comment on the post, which can be used to create a comment model on the frontend.
            "deleted": 0,
            "data": []
        },
        "fields": [],
        "first_name": null,
        "last_name": "Administrator",
        "created_by_name": " Administrator" This will be the locale-formatted full name of the user.
    }, ... ]
}
  	Last modified: 2023-02-03 21:04:03


/Administration/packages/:file_install/install GET
Overview
[ADMIN] PackageManager install a package.
Summary
Installs the specified package. Package 'file_install' hash must be provided. file_install hash could be found in staging package list.
Response
Returns http status 200 OK and newly installed package ID if request is successful.
{
"id": "56365210-4cce-11ea-a7bf-acde48001122"
}
Otherwise returns http status 4xx with errors.
{
"error": "not_found",
"error_message": "Could not find package by ID."
}
Change Log
Version
Change
v11.8
Added /Administration/packages/:file_install/installÂ GET endpoint.
  	Last modified: 2023-02-03 21:04:03


/CommentLog/:record GET
Overview
    Retrieves a record.
Request Arguments
    This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
            <record field>

            <record field type>

            Returns the fields for the selected record.

Response
{
   "id":"bdd59d85-687b-1739-b00a-512d09f6db9e",
   "name":"Insight Marketing Inc",
   "date_entered":"2013-02-26T19:12:00+00:00",
   "date_modified":"2013-02-26T19:12:00+00:00",
   "modified_user_id":"1",
   "modified_by_name":"Administrator",
   "created_by":"1",


"created_by":"1",
   "created_by_name":"Administrator",
   "description":"",
   "img":"",
   "last_activity_date":"2013-02-26T19:12:00+00:00",
   "deleted":false,
   "assigned_user_id":"seed_max_id",
   "assigned_user_name":"Max Jensen",
   "team_name":[
      {
         "id":"East",
         "name":"East",
         "name_2":"",
         "primary":false
      },
      {
         "id":1,
         "name":"Global",
         "name_2":"",
         "primary":false
      },
      {
         "id":"West",
         "name":"West",
         "name_2":"",


"name":"West",
         "name_2":"",
         "primary":true
      }
   ],
   "linkedin":"",
   "facebook":"",
   "twitter":"",
   "googleplus":"",
   "account_type":"Customer",
   "industry":"Electronics",
   "annual_revenue":"",
   "phone_fax":"",
   "billing_address_street":"345 Sugar Blvd.",
   "billing_address_street_2":"",
   "billing_address_street_3":"",
   "billing_address_street_4":"",
   "billing_address_city":"San Mateo",
   "billing_address_state":"CA",
   "billing_address_postalcode":"56019",
   "billing_address_country":"USA",


"billing_address_country":"USA",
   "rating":"",
   "phone_office":"(927) 136-9572",
   "phone_alternate":"",
   "website":"www.sectionvegan.de",
   "ownership":"",
   "employees":"",
   "ticker_symbol":"",
   "shipping_address_street":"345 Sugar Blvd.",
   "shipping_address_street_2":"",
   "shipping_address_street_3":"",
   "shipping_address_street_4":"",
   "shipping_address_city":"San Mateo",
   "shipping_address_state":"CA",
   "shipping_address_postalcode":"56019",
   "shipping_address_country":"USA",


"shipping_address_country":"USA",
   "email1":"kid.support.vegan@example.info",
   "parent_id":"",
   "sic_code":"",
   "parent_name":"",
   "email_opt_out":false,
   "invalid_email":false,
   "email":[
      {
         "email_address":"kid.support.vegan@example.info",
         "opt_out":"0",
         "invalid_email":"0",
         "primary_address":"1"
      },
      {
         "email_address":"phone.kid@example.cn",
         "opt_out":"0",
         "invalid_email":"0",
         "primary_address":"0"
      }
   ],
   "campaign_id":"",
   "campaign_name":"",


],
   "campaign_id":"",
   "campaign_name":"",
   "my_favorite":false,
   "_acl":{
      "fields":{
      }
   }
}
Change Log
Version
Change
            v10

            Added /<module>/:record GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/Opportunities/:record PUT
Overview
    Update a record of the specified type.
Request Arguments
Name
Type
Description
Required
            <record field>

            <record field type>

            The name value list of fields to populate.

            True

Request
{
    "name":"New Account Name",
    "phone_office":"(555) 888-5555",
    "website":"www.newsite.com",
    "meetings": {
    {
        "add": ["21e3385e-404f-b470-407e-54044e3d8024"],
        "delete": ["21e3385e-404f-b470-407e-54044e3d8023"],
        "create": [
        {
            "name": "Test Meeting"
        }


{
            "name": "Test Meeting"
        }
      ]
    }
}
Link fields
    It is possible to add or delete record relations to other records and create new related records.
Action
Type
Description
add
            List

            List of related records ID. See RelateRecordApi
            for details.

delete
            List

            List of related records ID.

create
            List

            List of name to value arrays of related records.

Response Arguments
Name
Type
Description
            <record field>

            <record field type>

            Returns the fields for the updated record.

Response
{
   "id":"f222265a-b755-da89-0bc7-512d09b800b6",
   "name":"New Account Name",


"name":"New Account Name",
   "date_entered":"2013-02-26T19:12:00+00:00",
   "date_modified":"2013-02-27T22:49:00+00:00",
   "modified_user_id":"1",
   "modified_by_name":"Administrator",
   "created_by":"1",
   "created_by_name":"Administrator",
   "description":"",
   "img":"",
   "last_activity_date":"2013-02-26T19:12:00+00:00",
   "deleted":false,
   "assigned_user_id":"seed_sarah_id",
   "assigned_user_name":"Sarah Smith",
   "team_name":[
      {
         "id":1,
         "name":"Global",


{
         "id":1,
         "name":"Global",
         "name_2":"",
         "primary":false
      },
      {
         "id":"West",
         "name":"West",
         "name_2":"",
         "primary":true
      }
   ],
   "linkedin":"",
   "facebook":"",
   "twitter":"",
   "googleplus":"",
   "account_type":"Customer",
   "industry":"Hospitality",
   "annual_revenue":"",
   "phone_fax":"",
   "billing_address_street":"9 IBM Path",
   "billing_address_street_2":"",
   "billing_address_street_3":"",
   "billing_address_street_4":"",
   "billing_address_city":"San Francisco",


"billing_address_city":"San Francisco",
   "billing_address_state":"CA",
   "billing_address_postalcode":"43635",
   "billing_address_country":"USA",
   "rating":"",
   "phone_office":"(555) 888-5555",
   "phone_alternate":"",
   "website":"www.newsite.com",
   "ownership":"",
   "employees":"",
   "ticker_symbol":"",
   "shipping_address_street":"9 IBM Path",
   "shipping_address_street_2":"",
   "shipping_address_street_3":"",
   "shipping_address_street_4":"",
   "shipping_address_city":"San Francisco",
   "shipping_address_state":"CA",


"shipping_address_state":"CA",
   "shipping_address_postalcode":"43635",
   "shipping_address_country":"USA",
   "email1":"kid86@example.net",
   "parent_id":"",
   "sic_code":"",
   "parent_name":"",
   "email_opt_out":false,
   "invalid_email":false,
   "email":[
      {
         "email_address":"kid86@example.net",
         "opt_out":"0",
         "invalid_email":"0",
         "primary_address":"1"
      },
      {
         "email_address":"the.dev@example.name",
         "opt_out":"0",
         "invalid_email":"0",
         "primary_address":"0"
      }


"primary_address":"0"
      }
   ],
   "campaign_id":"",
   "campaign_name":"",
   "my_favorite":false,
   "_acl":{
      "fields":{
      }
   }
}
Change Log
Version
Change
            v10

            Added /<module>/:record PUT endpoint.

  	Last modified: 2023-02-03 21:04:03


/Administration/search/status GET
Overview
    [ADMIN] Search status
Summary
    This endpoint returns the status of the search backend including a list of the activated full text search modules.
    This endpoint is only available to administrators.
Response
{
    "available":true,
    "enabled_modules":
    [
        "Accounts",
        "Bugs",
        "Calls",
        "Campaigns",
    ]
}
Change Log
Version
Change
            v10

            Added /Administration/search/status GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/me PUT
Overview
    Returns the current user object.
Request Arguments
    This endpoint does not accept any request arguments.
Response Arguments
Response User Example
{
   "current_user":{
      "type":"user",
      "id":"1",
      "full_name":"Administrator",
      "timepref":"h:ia",
      "timezone":"America/Los_Angles",
      "user_name":"admin"
   }
}
Response Portal User Example
{
   "current_user":{
      "type":"support_portal",
      "id":"1234-567",
      "user_id":"abcd-123",
      "full_name":"Bill Williamson",
      "timepref":"h:ia",
      "timezone":"America/Denver",


"timezone":"America/Denver",
      "user_name":"SupportPortalApi"
   }
}
Change Log
Version
Change
            v10

            Added /me PUT endpoint.

  	Last modified: 2023-02-03 21:04:03


/Emails/filter GET
Overview
    Lists filtered emails.
Summary
    Adds additional operators to Filter API that are
    specific to Emails. A special macro, $current_user_id, is a convenience that allows for finding emails
    involving the current user.
Filter By Sender
    This will return all emails sent by the current user, by the contact whose ID is
    fa300a0e-0ad1-b322-9601-512d0983c19a, using the email address sam@example.com, which is referenced by
    the ID b0701501-1fab-8ae7-3942-540da93f5017, or by the lead whose ID is
    73b1087e-4bb6-11e7-acaa-3c15c2d582c6 using the email address wally@example.com, which is referenced by


the ID b651d834-4bb6-11e7-bfcf-3c15c2d582c6.
{
  "filter": [{
    "$from": [{
      "parent_type": "Users",
      "parent_id": "$current_user_id"
    }, {
      "parent_type": "Contacts",
      "parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a"
    }, {
      "email_address_id": "b0701501-1fab-8ae7-3942-540da93f5017"
    }, {
      "parent_type": "Leads",


}, {
      "parent_type": "Leads",
      "parent_id": "73b1087e-4bb6-11e7-acaa-3c15c2d582c6",
      "email_address_id": "b651d834-4bb6-11e7-bfcf-3c15c2d582c6"
    }]
  }]
}
    Equivalent to:
{
  "filter": [{
    "from_collection": {
      "$in": [{
        "parent_type": "Users",
        "parent_id": "$current_user_id"
      }, {
        "parent_type": "Contacts",
        "parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a"


}, {
        "email_address_id": "b0701501-1fab-8ae7-3942-540da93f5017"
      }, {
        "parent_type": "Leads",
        "parent_id": "73b1087e-4bb6-11e7-acaa-3c15c2d582c6",
        "email_address_id": "b651d834-4bb6-11e7-bfcf-3c15c2d582c6"
      }]
    }
  }]
}
Filter By Recipients
    This would return all archived emails received by the current user.
{
  "filter": [{
    "$or": [{
      "$to": [{
        "parent_type": "Users",


"$to": [{
        "parent_type": "Users",
        "parent_id": "$current_user_id"
      }],
      "$cc": [{
        "parent_type": "Users",
        "parent_id": "$current_user_id"
      }],
      "$bcc": [{
        "parent_type": "Users",
        "parent_id": "$current_user_id"
      }]
    }]
  }, {
    "state": {
      "$in": [
        "Archived"
      ]
    }
  }]
}
    Equivalent to:
{
  "filter": [{
    "$or": [{
      "to_collection": {
        "$in": [{
          "parent_type": "Users",


"$in": [{
          "parent_type": "Users",
          "parent_id": "$current_user_id"
        }]
      },
      "cc_collection": {
        "$in": [{
          "parent_type": "Users",
          "parent_id": "$current_user_id"
        }]
      },
      "bcc_collection": {
        "$in": [{
          "parent_type": "Users",
          "parent_id": "$current_user_id"
        }]
      }
    }]
  }, {
    "state": {
      "$in": [
        "Archived"
      ]
    }
  }]
}
Filter By Sender and Recipients
    This would return all archived emails sent by a contact to the current user.
{


This would return all archived emails sent by a contact to the current user.
{
  "filter": [{
    "$from": [{
      "parent_type": "Contacts",
      "parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a"
    }]
  }, {
    "$or": [{
      "$to": [{
        "parent_type": "Users",
        "parent_id": "$current_user_id"
      }],
      "$cc": [{
        "parent_type": "Users",
        "parent_id": "$current_user_id"
      }],
      "$bcc": [{
        "parent_type": "Users",
        "parent_id": "$current_user_id"
      }]


"parent_id": "$current_user_id"
      }]
    }]
  }, {
    "state": {
      "$in": [
        "Archived"
      ]
    }
  }]
}
    Equivalent to:
{
  "filter": [{
    "from_collection": {
      "$in": [{
        "parent_type": "Contacts",
        "parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a"
      }]
    }
  }, {
    "$or": [{
      "to_collection": {
        "$in": [{
          "parent_type": "Users",
          "parent_id": "$current_user_id"
        }]
      },


}]
      },
      "cc_collection": {
        "$in": [{
          "parent_type": "Users",
          "parent_id": "$current_user_id"
        }]
      },
      "bcc_collection": {
        "$in": [{
          "parent_type": "Users",
          "parent_id": "$current_user_id"
        }]
      }
    }]
  }, {
    "state": {
      "$in": [
        "Archived"
      ]
    }
  }]
}
Change Log
Version
Change
            v10

            Added the $from, $to, $cc, and $bcc operators to
            /Emails/filter GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/Dashboards/:id/restore-metadata PUT
Overview
Restores the metadata for a module's dashboard to the default metadata.
Summary
This endpoint is used to restore the default metadata for a module's dashboard.
Request Arguments
Name
Type
Description
Required
dashboard_module
string
The module dashboard belongs to (e.g. Home, Cases, Accounts)
True
dashboard
string
The dashboard name (e.g. portal-home)
True
Request
{
    "dashboard_module":"Home",
    "dashboard":"portal-home"
}
Â
Response Example
{
    "id":"123",
    "name":"LBL_PORTAL_HOME",
    "dashboard_module": "Home",
    "view_name": "home",
    "metadata": {


"view_name": "home",
    "metadata": {
        "css_class": "portal-home-dashboard"
        "components": {...},
    },
    ...
}
Change Log
Version
Change
v11.13
AddedÂ /Dashboards/<id>/restore-metadataÂ PUT endpoint.
  	Last modified: 2023-02-03 21:04:03


/Users/:record/freebusy GET
    Get a user's FreeBusy schedule
Summary:
    This endpoint returns a list of time slots for which the specified person is busy.
Request
        GET /Users/:id/freebusy

Response
    {
      "id": "foo"
      "module": "Users",
      "freebusy": [
                    {
                      "start": "2014-08-24T08:45:00-04:00",
                      "end": "2014-08-24T09:15:00-04:00"
                    },
                    {
                      "start": "2014-08-30T05:45:00-04:00",
                      "end": "2014-08-30T06:15:00-04:00"
                    },
                    {


},
                    {
                      "start": "2014-09-12T15:45:00-04:00",
                      "end": "2014-09-12T16:15:00-04:00"
                    }
                  ]
    }

  	Last modified: 2023-02-03 21:04:03


/pmse_Project/validateCrmData/:data/:filter GET
Overview
Validates information about Fields, Modules, Users, Roles, etc.
Summary
This endpoint will validate the existence of various data related to the Process Definition.
Request Arguments
Name
Type
Description
Required
data
String
The type of data to be retrieved
True
filter
String
Filtering criteria to be applied to data retrieved
False
key
String
Key of the entry to search for within the given data and filter
True
Request
Note: "key" should be provided in the form of a URL query string.
Example Request:
/rest/v11_10/pmse_Project/validateCrmData/field/Accounts?key=data_entered
Response Arguments
Name
Type
Description
result
Boolean


Response Arguments
Name
Type
Description
result
Boolean
The result of the validation. True if the key exists in the specified data set; false otherwise
Response
{
    result: true
}
Change Log
Version
Change
v11_10
Added /pmse_Project/validateCrmData/:data/:filterÂ GET endpoint.
  	Last modified: 2023-02-03 21:04:03


/Meetings/:record DELETE
Overview
    Deletes either a single event record or a series of event records
Request Arguments
Name
Type
Description
Required
            all_recurrences

            Boolean

            Flag to delete all events in a series.

            False

Request
http://{site_url}/rest/v10/Meetings/2c9e5c09-6824-0d14-f5cb-5130321ac3cf?all_recurrences=true
Response Arguments
Name
Type
Description
            id

            String

            Returns the ID of the deleted record.

Response
{
    "id": "11cf0d0a-40af-8cb1-9da0-5057a5f511f9"
}
Change Log
Version
Change


}
Change Log
Version
Change
            v10

            Added /<module>/:record DELETE endpoint.

  	Last modified: 2023-02-03 21:04:03


/Calls POST
Overview
    Create a single event or a series of event records.
Request Arguments
Name
Type
Description
Required
            <record field>

            <record field type>

            The name value list of fields to populate.

            True

Request
{
    "name":"Department Meeting",
    "description":"Weekly Department Meeting",
    "date_start":"yyyy-mm-ddThh:mm:ss-00:00",
    "date_end":"yyyy-mm-ddThh:mm:ss-00:00",
    "repeat_type":"Weekly",
    "repeat_interval":"1",  /* Every Week */
    "repeat_dow":"25",      /* Tue and Fri */
    "repeat_count":"4",     /* 4 Recurrences */


"repeat_count":"4",     /* 4 Recurrences */
    "repeat_until":"",
}
Response Arguments
Name
Description
Start Date
End Date
            <record field>

            Returns the fields for the newly created record.

Response
{
}
Change Log
Version
Change
            v10

            Added /<module> POST endpoint.

  	Last modified: 2023-02-03 21:04:03


/Forecasts/:timeperiod_id/progressManager/:user_id GET
Projected Manager Data
Summary:
    This endpoint is used to return the json Data not already in client view for the Forecasts manager projected panel.
Query Parameters:
Param
Description
Optional
user_id
Show for a specific user, defaults to current user if not defined
Optional
timeperiod_id
Show for a specific time period, defaults to the current time period if one is not passed
Optional
Input Example:
{
    user_id:seed_sally_id
    timeperiod_id:36f7085a-5889-ea75-84c8-50f42bd1a5ba
}

Output Example:
{
    closed_amount: 0
    opportunities: 13
    pipeline_revenue: 470000
    quota_amount: 382000.000000
}


quota_amount: 382000.000000
}

  	Last modified: 2023-02-03 21:04:03


/login/marketingContentUrl GET
Overview
Returns the SugarCRM marketing content URL that is managed by the marketing team.
Summary
This API attempts to reach SugarCRM's marketing content URL. If the service is unreachable, a URL for the static content is returned.
Request Arguments
Name
Type
Description
Required
selected_language
String
Code for the desired marketing content language. (Eg. "en_us", "fr_FR"). Providing a certain language code does not guarantee that content returned will be in the provided language. If an invalid language is specified, will assume "en_us".
False. It uses the configured language if this parameter is missing. Defaults to "en_us".
static
Boolean
If set to true, return URL for static marketing content. Defaults to false.
False. If this parameter is missing, the API defaults to the dynamic content url.
Response Arguments


Response Arguments
Name
Type
Description
url
String
URL suitable for embedding in an iFrame that links to marketing content from SugarCRM.
Response
"https://www.sugarcrm.com/product-login-page-service/"
Change Log
Version
Change
v11_9
Added /login/marketingContentUrlÂ GET endpoint.
  	Last modified: 2023-02-03 21:04:03


/EmailAddresses POST
Overview
    Create a new email address.
Summary
    In the event that the email address already exists, that record will be returned without making any changes.
Request Arguments
Name
Type
Description
Required
                email_address

                String

                The email address.

                True

                invalid_email

                Boolean

true if the email address is invalid. false is the default.

                False

                opt_out

                Boolean

true if the email address is opted out. false is the default.

                False

Request
{
  "email_address": "eharmon@example.com",
  "invalid_email": false,
  "opt_out": false
}
Response Arguments
Name
Type
Description
                <record field>


}
Response Arguments
Name
Type
Description
                <record field>

                <record field type>

                Returns the fields for the newly created record.

Response
{
  "id": "a028341c-ba92-9343-55e7-56cf5beda121",
  "date_created": "2016-02-25T11:53:07-08:00",
  "date_modified": "2016-02-25T11:53:07-08:00",
  "deleted": false,
  "email_address": "eharmon@example.com",
  "email_address_caps": "EHARMON@EXAMPLE.COM",
  "invalid_email": false,
  "opt_out": false,
  "_acl": {
    "fields": {}
  },


"_acl": {
    "fields": {}
  },
  "_module": "EmailAddresses"
}
Change Log
Version
Change
            v10

            Added /EmailAddresses POST endpoint.

  	Last modified: 2023-02-03 21:04:03


/Forecasts/user/:user_id GET
ForecastsApi - user
Summary:
    This endpoint is used to return a user's id, user_name, full_name, first_name, last_name, and is_manager param given a user's id.
Query Parameters:
Param
Description
Optional
user_id
Returns user data for this specific user id
Â
Input Example:
        {
        user_id:seed_sally_id
        }

Output Example:
        {
            first_name: "Sally"
            full_name: "Sally Bronsen"
            id: "seed_sally_id"
            is_manager: false
            last_name: "Bronsen"
            user_name: "sally"
        }


user_name: "sally"
        }

  	Last modified: 2023-02-03 21:04:03


/Emails/:record/link/:link_name/:remote_id POST
Overview
    Creates a relationship to a pre-existing email.
Summary
    Cannot link existing Notes records as attachments (link: attachments) and existing EmailParticipants records
    as a sender (link: from) or recipients(links: to, cc, bcc). All other operations
    described in Relate Record API are supported.
Change Log
Version
Change
            v10

            Added /Emails/:record/link/:link_name/:remote_id POST endpoint.

  	Last modified: 2023-02-03 21:04:03


/integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value DELETE
Overview
Removes a relationship based on lhs_sync_key_field_name and rhs_sync_key_field_name. If both the LHS and RHS records can be found with the respective fields, and those records are related, then remove the relationship of the RHS record to the LHS record.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
lhs_sync_key_field_name
String


True
lhs_sync_key_field_name
String
The name of the LHS field that contains lhs_sync_key_field_value (the default field is namedÂ sync_key but can be renamed via code customization)
True
lhs_sync_key_field_value
String
A unique ID for the LHS record identifying it in an external system
True
link_name
String
A name for the link
True
rhs_sync_key_field_name
String
The name of the RHS field that contains rhs_sync_key_field_value (the default field is namedÂ sync_key but can be renamed via code customization)
True
rhs_sync_key_field_value
String
A unique ID for the RHS record identifying it in an external system
True
Request


A unique ID for the RHS record identifying it in an external system
True
Request
/integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value
Response Arguments
Name
Type
Description
record
String
The ID of the record.
related_record
String
The ID of the related record.
Response
Status 200
{
    "record": "a0328573-a252-a27c-3530-4e4297d4c9e1",
    "related_record": "a0328573-bc54-a554-3530-4e4297d4c9e1"
}
Status 422
{


}
Status 422
{
    "error": "invalid_parameter",
    "error_message": "Could not find record with :xhs_sync_key_field_name::xhs_sync_key_field_value in module: <module>"
}
Change Log
Version
Change
v11_10
Added /integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_valueÂ DELETE endpoint.
  	Last modified: 2023-02-03 21:04:03


/css GET
Overview
    Runs LessPHP for a platform and a theme and outputs an array of css files. If not found the css files
    will be compiled.
Request Arguments
Name
Type
Description
Required
platform
String
The theme platform - /themes/clients/***PLATFORM***/themeName/. Accepted values are 'base' and 'portal'.
No. (defaults to base)
themeName
String
The theme name - /themes/clients/platform/***THEMENAME***/.
No. (defaults to default)
Request
{
    platform: 'portal',
    themeName: 'default'
}
Response
{
    url: [


themeName: 'default'
}
Response
{
    url: [
        'cache/themes/clients/base/default/bootstrap_97c9cf53841dbe471c20d169e3533763.css',
        'cache/themes/clients/base/default/sugar_14c42516aad866b7f80cc896ce5c5406.css',
    ]
}
Change Log
Version
Change
            v10

            Added /<css> GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/<module>/filter/count GET
Overview
    Lists filtered records.
Summary
    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields
    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.
    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise
    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:
    "link_name.remote_field", so if you wished to search the Accounts module by a related member account you would
    use "members.sic_code".
Request Arguments
Name
Type
Description
Required
            filter

            String


Name
Type
Description
Required
            filter

            String

            The filter expression. Filter expressions are explained below.

            False

            filter_id

            String

            Identifier for a preexisting filter. If filter is also set, the two
            filters are joined with an AND.

            False

            max_num

            Integer

            A maximum number of records to return. Default is 20.

            False

            offset

            Integer

            The number of records to skip over before records are returned. Default is 0.

            False

            fields

            String

            Comma delimited list of fields to return. The field date_modified will always be returned.

            Example: name,account_type,description
            False


Example: name,account_type,description
            False

            view

            String

            Instead of defining the fields argument, the view argument can be used instead. The field list is
            constructed at the server side based on the view definition which is requested. This argument can be used
            in combination with the fields argument. Common views are "record" and "list".

            Example: record
            False

            order_by

            String

            How to sort the returned records, in a comma delimited list with the direction appended to the column name
            after a colon.

            Example: name:DESC,account_type:DESC,date_modified:ASC
            False

Filter Expressions
There are four types of filters:
Basic


False

Filter Expressions
There are four types of filters:
Basic
    This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
    Example
{
   "filter":[
      {
         "name":"Nelson Inc"
      }
   ]
}
Full
    This expression allows you to specify what operation you want to use for filtering on the field. In the example
    you would match any record where the field "name" starts with the value "Nelson".
    Example
{
   "filter":[
      {
         "name":{
            "$starts":"Nelson"
         }
      }
   ]
}
        Below is a list of operation types:

Operation
Description
                $equals

                Performs an exact match on that field.


$equals

                Performs an exact match on that field.

                $not_equals

                Performs an exact match on that field.

                $not_equals

                Matches on non-matching values.

                $starts

                Matches on anything that starts with the value.

                $ends

                Matches anything that ends with the value.

                $contains

                Matches anything that contains the value

                $in

                Finds anything where field matches one of the values as specified as an array.

                $not_in

                Finds anything where field does not matches any of the values as specified as an array.

                $is_null


$is_null

                Checks if the field is null. This operation does not need a value specified.

                $not_null

                Checks if the field is not null. This operation does not need a value specified.

                $lt

                Matches when the field is less than the value.

                $lte

                Matches when the field is less than or equal to the value.

                $gt

                Matches when the field is greater than the value.

                $gte

                Matches when the field is greater than or equal to the value.

Sub-expressions
    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.


The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
    accepted sub-expression types are "$and" and "$or".
    Example
{
   "filter":[
      {
         "$or":[
            {
               "name":"Nelson Inc"
            },
            {
               "name":"Nelson LLC"
            }
         ]
      }
   ]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
   "filter":[
      {


Example
{
   "filter":[
      {
         "$favorite":"_this"
      }
   ]
}
Response Arguments
Name
Type
Description
            next_offset

            Integer

            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
            records.

            records

            Array

            An array of results containing matched records.

Response
{
   "next_offset":-1,
   "records":[
      {
         "id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
         "name":"Dale Spivey",
         "date_entered":"2013-02-26T19:12:00+00:00",


"date_modified":"2013-02-28T05:03:00+00:00",
         "modified_user_id":"1",
         "modified_by_name":"Administrator",
         "created_by":"1",
         "created_by_name":"Administrator",
         "description":"",
         "img":"",
         "deleted":false,
         "assigned_user_id":"seed_sally_id",
         "assigned_user_name":"Sally Bronsen",
         "team_name":[
            {
               "id":"East",
               "name":"East",
               "name_2":"",
               "primary":false
            },
            {
               "id":1,
               "name":"Global",
               "name_2":"",
               "primary":false
            },
            {


"name_2":"",
               "primary":false
            },
            {
               "id":"West",
               "name":"West",
               "name_2":"",
               "primary":true
            }
         ],
         "salutation":"",
         "first_name":"Dale",
         "last_name":"Spivey",
         "full_name":"Dale Spivey",
         "title":"VP Operations",
         "linkedin":"",
         "facebook":"",
         "twitter":"",
         "googleplus":"",
         "department":"",
         "do_not_call":false,
         "phone_home":"(523) 825-4311",
         "email":[
            {
               "email_address":"sugar.dev.sugar@example.co.jp",


"opt_out":"0",
               "invalid_email":"0",
               "primary_address":"1"
            },
            {
               "email_address":"the.support@example.biz",
               "opt_out":"0",
               "invalid_email":"0",
               "primary_address":"0"
            }
         ],
         "phone_mobile":"(373) 861-0757",
         "phone_work":"(212) 542-9596",
         "phone_other":"",
         "phone_fax":"",
         "email1":"sugar.dev.sugar@example.co.jp",
         "email2":"the.support@example.biz",
         "invalid_email":false,
         "email_opt_out":false,
         "primary_address_street":"345 Sugar Blvd.",


"primary_address_street":"345 Sugar Blvd.",
         "primary_address_street_2":"",
         "primary_address_street_3":"",
         "primary_address_city":"Denver",
         "primary_address_state":"CA",
         "primary_address_postalcode":"87261",
         "primary_address_country":"USA",
         "alt_address_street":"",
         "alt_address_street_2":"",
         "alt_address_street_3":"",
         "alt_address_city":"",
         "alt_address_state":"",
         "alt_address_postalcode":"",
         "alt_address_country":"",
         "assistant":"",
         "assistant_phone":"",
         "picture":"",
         "email_and_name1":"",


"picture":"",
         "email_and_name1":"",
         "lead_source":"Campaign",
         "account_name":"Smallville Resources Inc",
         "account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
         "opportunity_role_fields":"",
         "opportunity_role_id":"",
         "opportunity_role":"",
         "reports_to_id":"",
         "report_to_name":"",
         "portal_name":"DaleSpivey97",
         "portal_active":true,
         "portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/",
         "portal_password1":"",


"portal_password1":"",
         "portal_app":"",
         "preferred_language":"en_us",
         "campaign_id":"",
         "campaign_name":"",
         "c_accept_status_fields":"",
         "m_accept_status_fields":"",
         "accept_status_id":"",
         "accept_status_name":"",
         "sync_contact":"",
         "my_favorite":false,
         "_acl":{
            "fields":{
            }
         }
      },
      {
         "id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
         "name":"Florence Haddock",
         "date_entered":"2013-02-26T19:12:00+00:00",