Let the platform do the work
SugarClubContact+1 (877) 842-7276

/Calendar/invitee_search GET

Overview

Temporary API - Do Not Use! This endpoint will be removed in an upcoming release. Use /search endpoint instead. Searches for people to invite to an event (meeting or call).

Request Arguments

Name Type Description Required
q String The search text to match records on. True
module_list String Comma delimited list of modules to search. True
search_fields String Comma delimited list of fields to search. True
fields String Comma delimited list of fields to return. Search fields will automatically be added to return list. True

Response Arguments

Name Type Description
next_offset Integer Currently only returns -1 as paging is not supported yet.
records Array An array of results containing matched records.

Response

{
    "next_offset": -1,
    "records": [
        {
            "id": "17283aad-8d15-c545-fc5a-5422fe3d8ef8",
            "date_modified": "2014-09-24T13:25:28-04:00",
            "email": [
                {
                    "email_address": "hr.phone.support@example.cn",
                    "invalid_email": false,
                    "opt_out": true,
                    "primary_address": false,
                    "reply_to_address": false
                },
                {
                    "email_address": "section.section.phone@example.edu",
                    "invalid_email": false,
                    "opt_out": false,
                    "primary_address": true,
                    "reply_to_address": true
                }
            ],
            "full_name": "Renaldo Cuffee",
            "account_name": "EEE Endowments LTD",
            "_acl": {
                "fields": {}
            },
            "_module": "Contacts",
            "_search": {
                "highlighted": {
                    "account_name": {
                        "text": "EEE Endowments LTD",
                        "module": "Contacts",
                        "label": "LBL_ACCOUNT_NAME"
                    }
                }
            }
        },
        {
            "id": "19c0fa4a-a6c0-940f-7ad6-5422fe62a00a",
            "date_modified": "2014-09-24T13:25:28-04:00",
            "email": [
                {
                    "email_address": "qa.beans@example.com",
                    "invalid_email": false,
                    "opt_out": true,
                    "primary_address": false,
                    "reply_to_address": false
                },
                {
                    "email_address": "the.phone.sales@example.de",
                    "invalid_email": false,
                    "opt_out": false,
                    "primary_address": true,
                    "reply_to_address": true
                }
            ],
            "full_name": "Noble Canto",
            "account_name": "EEE Endowments LTD",
            "_acl": {
                "fields": {}
            },
            "_module": "Contacts",
            "_search": {
                "highlighted": {
                    "account_name": {
                        "text": "EEE Endowments LTD",
                        "module": "Contacts",
                        "label": "LBL_ACCOUNT_NAME"
                    }
                }
            }
        }
    ]
}

Change Log

Version Change
v10 Added /<module>/send_invites GET endpoint.