Developers

Designed for developers with varying skills and experience to integrate and create their own apps. All API calls are made using HTTP POST or GET

  • getUsers

    Current Version: 1.00 | State: Beta
    This API fetches Users from Connector HQ
    API URL: https://app.connectorhq.com/api/getUsers.php
    Parameters for this call:

    Each API call requires you to pass certain parameters in order to return correct responses.
    Here’s a list of those parameters relevant to this API call.

    Parameter Type Description Required Example
    api_key Alphanumeric API Key Yes 913456236821f48699e8544471gy
    account_email Alphanumeric Account Email Yes info@mail.com
    Response Generated:

    JSON
    {
      "Active":{
        "6565":{
          "email":{
        "label":"Email",
        "value":"jane.s@mail.com"
          },
          "fname":{
        "label":"First Name",
        "value":"Jane"
          },
          "lname":{
        "label":"Last Name",
        "value":"Smith"
          },
          "department":{
        "label":"Department",
        "value":"1"
          },
          "boss":{
        "label":"Boss",
        "value":"6565"
          },
          "phone":{
        "label":"Phone",
        "value":"0800 89 21 11"
          },
          "phonextn":{
        "label":"Xtn",
        "value":"203"
          },
          "mobile":{
        "label":"Mobile",
        "value":"0210211211"
          },
          "skype":{
        "label":"Skype Handle",
        "value":"jane.s"
          },
          "user_level":{
        "label":"User Level",
        "value":"1"
          },
          "avatar":{
        "label":"avatar",
        "value":"http:\/\/app2.dimensioncrm.com\/uploads\/62\/avatars\/Jane.png"
          },
          "cf_1":{
        "label":"Employment Type",
        "value":"Contractor"
          },
          "cf_2":{
        "label":"IRD num",
        "value":"1233-211-211"
          }
        }
      },
      "Inactive":{
        "6565":{
          "email":{
        "label":"Email",
        "value":"john.c@mail.com"
          },
          "fname":{
        "label":"First Name",
        "value":"John"
          },
          "lname":{
        "label":"Last Name",
        "value":"Cole"
          },
          "department":{
        "label":"Department",
        "value":"1"
          },
          "boss":{
        "label":"Boss",
        "value":"6565"
          },
          "phone":{
        "label":"Phone",
        "value":"0800 89 22 33"
          },
          "phonextn":{
        "label":"Xtn",
        "value":"204"
          },
          "mobile":{
        "label":"Mobile",
        "value":"0210242112"
          },
          "skype":{
        "label":"Skype Handle",
        "value":"john.c"
          },
          "user_level":{
        "label":"User Level",
        "value":"1"
          },
          "avatar":{
        "label":"avatar",
        "value":"http:\/\/app2.dimensioncrm.com\/uploads\/62\/avatars\/John.png"
          },
          "cf_1":{
        "label":"Employment Type",
        "value":"Contractor"
          },
          "cf_2":{
        "label":"IRD num",
        "value":"1233-231-221"
          }
        }
      },
      "total":2,
      "success":"true",
      "error":200,
      "error_msg":"OK"
    }
    Last Modified: 08 Jul 2013

     

  • getSaleItems

    Current Version: 1.00 | State: Beta
    This API fetches Sales Items from Connector HQ
    API URL: https://app.connectorhq.com/api/getSaleItems.php
    Parameters for this call:

    Each API call requires you to pass certain parameters in order to return correct responses.
    Here’s a list of those parameters relevant to this API call.

    Parameter Type Description Required Example
    api_key Alphanumeric API Key Yes info@mail.com
    account_email Alphanumeric Account Email Yes info@mail.com
    category_id Integer Category ID No 39
    Response Generated:

    JSON
    {
      "sale_items":{
        "19":{
          "category_id":"39",
          "name":"Micro Plan",
          "value":"25",
          "units":"per month",
          "description":"
    
    This plan is the first sample plan<\/p>\r\n"
        },
        "20":{
          "category_id":"39",
          "name":"Fire Wood",
          "value":"35",
          "units":"kg",
          "description":"
    
    This item is the first sample item<\/p>\r\n"
        }
      },
      "success":"true",
      "error":200,
      "error_msg":"OK"
    }
    Last Modified: 08 Jul 2013
  • getOpportunity

    Current Version: 1.00 | State: Beta
    This API fetches Opportunity record from Connector HQ
    API URL: https://app.connectorhq.com/api/getOpportunity.php
    Parameters for this call:Each API call requires you to pass certain parameters in order to return correct responses.
    Here’s a list of those parameters relevant to this API call.
    Parameter Type Description Required Example
    api_key Alphanumeric API Key Yes 913456236821f48699e8544471gy
    account_email Alphanumeric Account Email Yes info@mail.com
    opportunity_id Integer Opportunity ID Yes 12703
    Response Generated:

    JSON
    {
      "12703":{
        "contact_id":{
          "label":"Contact ID",
          "value":"21705"
        },
        "date_created":{
          "label":"Date Created",
          "value":"1371784044",
          "formatted":"20\/06\/2013"},
        "closing":{
        "label":"Closing Date",
        "value":"1382152044",
        "formatted":"18\/10\/2013"
          },
        "timeline":{
          "label":"Timeline",
          "value":"120"
        },
        "value":{
          "label":"Value",
          "value":"100.5"
        },
        "probability":{
          "label":"Probability",
          "value":"50"
        },
        "acm":{
          "label":"Account Manager",
          "value":"6618"
        },
        "next_followup":{
          "label":"Scheduled Followup",
          "value":"1380085200"
        },
        "status":{
          "label":"Status",
          "value":"Active"
        },
        "cf_1":{
          "label":"Type of Sale",
          "value":"Upgrade"
        },
        "cf_2":{
          "label":"Channel",
          "value":"App Dev"
        }
      },
      "success":"true",
      "error":200,
      "error_msg":"OK"
    }
    Last Modified: 08 Jul 2013
  • getOpportunity

    Current Version: 1.00 | State: Beta
    This API fetches Notes from a Contact record in Connector HQ
    API URL: https://app.connectorhq.com/api/getNotes.php
    Parameters for this call:Each API call requires you to pass certain parameters in order to return correct responses.
    Here’s a list of those parameters relevant to this API call.
    Parameter Type Description Required Example
    api_key Alphanumeric API Key Yes 913456236821f48699e8544471gy
    account_email Alphanumeric Account Email Yes info@mail.com
    opportunity_id Integer Contact ID Yes 21705
    Response Generated:

    JSON
    {
      "21705":{
        "20\/06\/2013":{
          "16562":{
        "user_id":"6572",
        "user_email":"frank.r@mail.com",
        "user_name":"Frank Robinson",
        "timestamp":"1371770032",
        "private":"y",
        "shared_with":["6566","6582"],
        "text":"This is a sample note"
          }
        }
      },
      "success":"true",
      "error":200,
      "error_msg":"OK"
    }
    Last Modified: 08 Jul 2013
  • getItemCategories

    Current Version: 1.00 | State: Beta
    This API fetches Item Categories from Connector HQ
    API URL: https://app.connectorhq.com/api/getItemCategories.php
    Parameters for this call:Each API call requires you to pass certain parameters in order to return correct responses.
    Here’s a list of those parameters relevant to this API call.
    Parameter Type Description Required Example
    api_key Alphanumeric API Key Yes 913456236821f48699e8544471gy
    account_email Alphanumeric Account Email Yes info@mail.com
    Response Generated:

    JSON
    {
      "categories":
      {
        "39":{
          "name":"Category A"
        },
        "40":{
          "name":"Category B"
        },
        "41":{
          "name":"Category C"
        },
        "42":{
          "name":"Category D"
        },
        "43":{
          "name":"Category E"
        }
      },
      "success":"true",
      "error":200,
      "error_msg":"OK"
    }
    
    Last Modified: 08 Jul 2013
  • getContactEvents
    Current Version: 1.00 | State: Beta
    This API fetches Event records based from Contact in Connector HQ
    API URL: https://app.connectorhq.com/api/getContactEvents.php
    Parameters for this call:
    Each API call requires you to pass certain parameters in order to return correct responses.
    Here’s a list of those parameters relevant to this API call.
    Parameter Type Description Required Example
    api_key Alphanumeric API Key Yes 913456236821f48699e8544471gy
    account_email Alphanumeric Account Email Yes info@mail.com
    contact_id Integer Contact ID Yes 21705
    user_id Integer User ID No 6572
    Response Generated:

    JSON
    {
      "21705":{
        "upcoming":[
          {
        "id":"10130",
        "owner":"David Johnson",
        "owner_email":"dj@mail.com",
        "owner_id":"6572",
        "date":"2013-06-21",
        "time":"17:30:00",
        "subject":"Sample Event",
        "description_text":"Test Event",
        "description_html":"<\/p>Test Event<\/p>"
          }
        ]  },
      "success":"true",
      "error":200,
      "error_msg":"OK"
    }
    Last Modified: 08 Jul 2013
  • getAdditionalContacts
    Current Version: 1.00 | State: Beta
    This API fetches Additional contact records of a Contact in Connector HQ
    API URL: https://app.connectorhq.com/api/getAdditionalContacts.php
    Parameters for this call:
    Each API call requires you to pass certain parameters in order to return correct responses.
    Here’s a list of those parameters relevant to this API call.
    Parameter Type Description Required Example
    api_key Alphanumeric API Key Yes 913456236821f48699e8544471gy
    account_email Alphanumeric Account Email Yes info@mail.com
    contact_id Integer Contact ID Yes 21705
    Response Generated:

    JSON
    {
      "21705":{
        "108":{
          "email":"jr@mail.com",
          "fname":"John",
          "lname":"Robinson",
          "mobile":"0213121211",
          "phone":"08003211122",
          "phonextn":"112",
          "position":"CEO",
          "im_type":"Skype",
          "im_handle":"j.robinson"
        }
      },
      "success":"true",
      "error":200,
      "error_msg":"OK"
    }
    Last Modified: 08 Jul 2013

    r

  • getContact
    Current Version: 1.00 | State: Beta
    This API fetches a Contact record from Connector HQ
    API URL: https://app.connectorhq.com/api/getContact.php
    Parameters for this call:
    Each API call requires you to pass certain parameters in order to return correct responses.
    Here’s a list of those parameters relevant to this API call.
    Parameter Type Description Required Example
    api_key Alphanumeric API Key Yes 913456236821f48699e8544471gy
    account_email Alphanumeric Account Email Yes info@mail.com
    contact_id Integer Contact ID Yes 21705
    Response Generated:

    JSON
    {
      "21705":{
        "type":{
          "label":"Contact Type",
          "value":"Leads"
        },
        "industry":{
          "label":"Industry Type",
          "value":"Retail and Wholesale"
        },
        "company":{
          "label":"Company",
          "value":"Optimizer HQ"
        },
        "salutation":{
          "label":"Salutation",
          "value":"Mr"
        },
        "fname":{
          "label":"First Name",
          "value":"John"
        },
        "lname":{
          "label":"Last Name",
          "value":"Doe"
        },
        "address":{
          "label":"Address",
          "value":"16 Rainbow Avenue"
        },
        "address2":{
          "label":"Address line2",
          "value":"Auckland Central, New Zealand"
        },
        "suburb":{
          "label":"Suburb\/town\/District",
          "value":"Greenlane"
        },
        "city":{
          "label":"City",
          "value":"Auckland"
        },
        "state":{
          "label":"State",
          "value":"New South Wales"
        },
        "zip":{
          "label":"Zip\/Postal Code",
          "value":"0644"
        },
        "country":{
          "label":"Country",
          "value":"New Zealand"
        },
        "postaddress":{
          "label":"Post Address",
          "value":"PO BOX 1234, Ellerslie"
        },
        "postaddress2":{
          "label":"Post Address line 2",
          "value":"Auckland, 1624, New Zealand"
        },
        "phone":{
          "label":"Phone Number",
          "value":"09-555-7788"
        },
        "phonextn":{
          "label":"Xtn",
          "value":"211"
        },
        "fax":{
          "label":"FAX",
          "value":"09-555-7789"
        },
        "email":{
          "label":"Email",
          "value":"johndoe@gmail.com"
        },
        "website":{
          "label":"Web",
          "value":"http:\/\/www.mywebsite.com"
        },
        "mobile":{
          "label":"Mobile",
          "value":"+64212131111"
        },
        "afterhrphone":{
          "label":"After Hours Phone",
          "value":"09-555-7799"
        },
        "acquireddate":{
          "label":"Acquired Date",
          "value":"2013-09-25"
        },
        "source":{
          "label":"Contact Source",
          "value":"Telemarketing"
        },
        "position":{
          "label":"Position",
          "value":"Department Manager"
        },
        "acm":{
          "label":"Account Manager",
          "value":"6618"
        },
        "facebook":{
          "label":"Facebook",
          "value":"http:\/\/www.facebook.com\/johndoe"
        },
        "twitter":{
          "label":"Twitter",
          "value":"https:\/\/twitter.com\/johndoe"
        },
        "linkedin":{
          "label":"Linkedin",
          "value":"http:\/\/nz.linkedin.com\/pub\/john-doe\/35\/251\/403"
        }
      },
      "success":"true",
      "error":200,
      "error_msg":"OK"
     }
    Last Modified: 08 Jul 2013
  • addQuote
    Current Version: 1.00 | State: Beta
    This API creates a new Quote record for an Opportunity record in Connector HQ
    API URL: https://app.connectorhq.com/api/addQuote.php
    Parameters for this call:
    Each API call requires you to pass certain parameters in order to return correct responses.
    Here’s a list of those parameters relevant to this API call.
    Parameter Type Description Required Example
    api_key Alphanumeric API Key Yes 913456236821f48699e8544471gy
    account_email Alphanumeric Account Email Yes info@mail.com
    opportunity_id Integer Opportunity ID Yes 17
    qty Alphanumeric List of quantities of sale items delimited by comma (,) Yes 10,4,2,1
    value Alphanumeric List of sale values delimited by comma (,) Yes 100.00,50.00,30.00,150.00
    item_id Alphanumeric List of sale item ID delimited by comma (,) Yes 39,40,41,42
    Response Generated:

    JSON
    {"success":"true","error":200,"error_msg":"OK"}
    The list of quantity and value should match the list of sale items.
    Last Modified: 08 Jul 2013
  • addOpportunity
    Current Version: 1.00 | State: Beta
    This API creates a new opportunity record in Connector HQ
    API URL: https://app.connectorhq.com/api/addOpportunity.php
    Parameters for this call:
    Each API call requires you to pass certain parameters in order to return correct responses.
    Here’s a list of those parameters relevant to this API call.
    Parameter Type Description Required Example
    api_key Alphanumeric API Key Yes 913456236821f48699e8544471gy
    account_email Alphanumeric Account Email Yes info@mail.com
    contact_id Integer Contact ID Yes 10
    acm Integer Account Manager’s User ID Yes 6566
    cf_{x} Alphanumeric Contact’s custom field. {x} stands for the custom field ID. No Value depends on the Sales Module Custom field’s type and set values
    probability Integer Probability options are 10,25,50,75,100 No 50
    value Float Opportunity value No 100.00
    followup Alphanumeric Opportunity follow up date (format:yyyy-mm-dd) No 2013-09-25
    timeline Integer Time to fruition No 120
    Response Generated:

    JSON
    {"opportunity_id":"12700","success":"true","error":200,"error_msg":"OK"}

    Values for Time of Fruition

      1 Day        = 1
      2 Days       = 2
      3 Days       = 3
      1 Week      = 7
      2 Weeks     = 14
      3 Weeks     = 21
      1 Month     = 30
      2 Months    = 60
      3 Months    = 90
      4 Months    = 120
      5 Months    = 150
      6 Months    = 180
      7 Months    = 210
      8 Months    = 240
      9 Months    = 270
      10 Months  = 300
      11 Months  = 330
      12 Months  = 360

    Last Modified: 08 Jul 2013
  • addNote
    Current Version: 1.00 | State: Beta
    This API adds a note into contact record in Dimension CRM
    API URL: https://app.connectorhq.com/api/addNote.php
    Parameters for this call:
    Each API call requires you to pass certain parameters in order to return correct responses.
    Here’s a list of those parameters relevant to this API call.
    Parameter Type Description Required Example
    api_key Alphanumeric API Key Yes 913456236821f48699e8544471gy
    account_email Alphanumeric Account Email Yes info@mail.com
    user_id Integer User ID Yes 25
    contact_id Integer Contact ID Yes 10
    private Alphanumeric Set note as private No y or n
    shared_with Alphanumeric A series of User ID delimited by comma (,) that should have shared access with the note No 6566,6582
    text Alphanumeric Note Yes This is a sample note.
    Response Generated:

    JSON
    {"success":"true","error":200,"error_msg":"OK"}
    Last Modified: 08 Jul 2013
  • addContact
    Current Version: 1.00 | State: Beta
    This API creates a new contact record in Dimension CRM
    API URL: https://app.connectorhq.com/api/addContact.php
    Parameters for this call:
    Each API call requires you to pass certain parameters in order to return correct responses.
    Here’s a list of those parameters relevant to this API call.
    Parameter Type Description Required Example
    api_key Alphanumeric API Key Yes 913456236821f48699e8544471gy
    account_email Alphanumeric Account Email Yes info@mail.com
    fname Alphanumeric Contact’s first name Yes John
    lname Alphanumeric Contact’s last name Yes Doe
    email Alphanumeric Contact’s email address Yes johndoe@mail.com
    acm Integer Account Manager’s User ID Yes 15
    cf_{x} Alphanumeric Contact’s custom field. {x} stands for the custom field ID. No Value depends on the Custom field’s type and set values
    private Alphanumeric Sets Contact record as private No y or n
    type Alphanumeric Contact’s relationship type No Leads
    industry Alphanumeric Contact’s industry type No Retail and Wholesale
    company Alphanumeric Contact’s company name No Optimizer HQ
    salutation Alphanumeric Contact’s salutation No Mr
    address Alphanumeric Contact’s address No 16 Rainbow Avenue
    address2 Alphanumeric Contact’s address continuation No Auckland Central, New Zealand
    suburb Alphanumeric Contact’s suburb No Greenlane
    city Alphanumeric Contact’s city No Auckland
    state Alphanumeric Contact’s state No New South Wales
    zip Alphanumeric Contact’s zip code No 0644
    country Alphanumeric Contact’s country No New Zealand
    postaddress Alphanumeric Contact’s postal address No PO BOX 1234, Ellerslie
    postaddress2 Alphanumeric Contact’s postal address continuation No Auckland, 1624, New Zealand
    phone Alphanumeric Contact’s phone number No 09-555-7788
    phonextn Alphanumeric Contact’s phone extension number No 211
    fax Alphanumeric Contact’s fax number No 09-555-7789
    website Alphanumeric Contact’s website URL No http://www.mywebsite.com
    mobile Alphanumeric Contact’s mobile number No +64212131111
    afterhrphone Alphanumeric Contact’s after hours phone number No 09-555-7799
    acquireddate Alphanumeric Contact’s acquire date. (format:yyyy-mm-dd) No 2013-09-25
    source Alphanumeric Contact’s source No Telemarketing
    position Alphanumeric Contact’s position No Department Manager
    facebook Alphanumeric Contact’s Facebook page No http://www.facebook.com/johndoe
    twitter Alphanumeric Contact’s Twitter page No https://twitter.com/johndoe
    linkedin Alphanumeric Contact’s LinkedIn page No http://nz.linkedin.com/pub/john-doe/35/251/403
    Response Generated:

    JSON
    {"contact_id":"21702","success":"true","error":200,"error_msg":"OK"}
    Last Modified: 08 Jul 2013
  • addAdditionalContact
    Current Version: 1.00 | State: Beta
    This API creates additional contact into contact record in Dimension CRM
    API URL: https://app.connectorhq.com/api/addAdditionalContact.php
    Parameters for this call:
    Each API call requires you to pass certain parameters in order to return correct responses.
    Here’s a list of those parameters relevant to this API call.
    Parameter Type Description Required Example
    api_key Alphanumeric API Key Yes 913456236821f48699e8544471gy
    account_email Alphanumeric Account Email Yes info@mail.com
    contact_id Alphanumeric Contact ID Yes 10
    fname Alphanumeric Additional contact’s first name Yes John
    lname Alphanumeric Additional contact’s last name Yes Doe
    email Alphanumeric Additional contact’s email address Yes johndoe@mail.com
    phone Alphanumeric Additional contact’s phone number No 09-555-7788
    phonextn Alphanumeric Additional contact’s extension number No 211
    mobile Alphanumeric Additional contact’s mobile number No +64212131111
    position Alphanumeric Additional contact’s position No Department Manager
    Response Generated:

    JSON
    {"success":"true","error":200,"error_msg":"OK"}
    Last Modified: 08 Jul 2013