Getting started

Contacts

GET api/v2/Organisation/{Slug}/Contacts

Description: Return a list of contacts that meet a certain criteria Example: https://api.totalsynergy.com/api/v2/Organisation/testOrg/Contacts?ShowStaff=false
Optional Parameters:
ShowCompany Boolean value whether to show company contacts
ShowPersonnel Boolean value whether to show personnel contacts
ShowIndividual Boolean value whether to show individual contacts
ShowStaff Boolean value whether to show staff contacts
MinSecurityLevel Int value whether to filter contacts that are above a certain security level
UpdatedDate UTC date value - only include contacts updated on or after this date
CreatedDate UTC date value - only include contacts created on or after this date
Response: 

{
    "totalItems": 234,
    "criteria": null,
    "items": [{
            "id": 1,
            "contactTypeId": 31,
            "organisationId": 112,
            "organisation": null,
            "avatar": null,
            "isStaff": false,
            "staffTypeName": null,
            "phones": {
                "mobile": "",
                "phone": "",
                "phone2": "",
                "phone3": "",
                "phone4": null,
                "phone5": null,
                "phone6": null,
                "skypeName": "test",
                "twitter": "",
                "linkedIn": "",
                "hasPhones": true
            },
            "timezoneId": "AUS Eastern Standard Time",
            "userCurrentDate": "2019-06-05T18:06:43.8118522",
            "rolesDisplay": null,
            "roleIds": [166],
            "emailDomain": "test@test.com.au",
            "web": null,
            "jobTitle": null,
            "name": "testdata",
            "initials": "0",
            "localTime": "Wed, Jun 5, 2019 - 6:06 PM",
            "salutationId": 81,
            "salutation": "Mrs",
            "firstName": "test",
            "lastName": "data",
            "email": "test@test.com",
            "cardId": "9897",
            "hasAddresses": true,
            "addressHome": {
                "id": 28718695,
                "address1": "",
                "address2": "",
                "town": "",
                "state": "NSW",
                "zipCode": "",
                "country": "Australia",
                "latitude": 0.0,
                "longitude": 0.0,
                "hasAddress": false,
                "singleline": null,
                "googleAddress": null,
                "stateZipCountry": "NSW, Australia"
            },
            "addressWork": {
                "id": 28718697,
                "address1": "",
                "address2": "",
                "town": "",
                "state": "NSW",
                "zipCode": "",
                "country": "",
                "latitude": 0.0,
                "longitude": 0.0,
                "hasAddress": false,
                "singleline": null,
                "googleAddress": null,
                "stateZipCountry": "NSW"
            },
            "addressPostal": {
                "id": 28718696,
                "address1": "",
                "address2": "",
                "town": "",
                "state": "NSW",
                "zipCode": "",
                "country": "Australia",
                "latitude": 0.0,
                "longitude": 0.0,
                "hasAddress": false,
                "singleline": null,
                "googleAddress": null,
                "stateZipCountry": "NSW,  Australia"
            },
            "addressOther": {
                "id": 28718698,
                "address1": "",
                "address2": "",
                "town": "",
                "state": "",
                "zipCode": "",
                "country": "",
                "latitude": 0.0,
                "longitude": 0.0,
                "hasAddress": false,
                "singleline": null,
                "googleAddress": null,
                "stateZipCountry": ""
            },
            "typeColumnDisplay": null,
            "typeDisplay": null,
            "website": "",
            "phoneDisplay": null,
            "profileImageURL": null,
            "email2": null,
            "email3": null,
            "email4": null,
            "isActive": true,
            "abn": "",
            "acn": "",
            "contactStatusId": 39,
            "contactStatus": "Active",
            "accountManagerId": null,
            "accountManagerName": "",
            "accountCode": null,
            "subContactTypeId": 0,
            "parentContactId": 7133530,
            "parentContactName": "test",
            "tags": null,
            "position": null,
            "createdDate": "2019-02-27T00:36:31.14",
            "updatedDate": "2019-02-27T00:36:31.14"
        }
    ],
    "currentPage": 1,
    "pageSize": 10,
    "totalPages": 24,
    "hasNext": true
}

Try it out
Loading...
200 
        {Response body}
Method
GET
Request Headers
'Content-Type': 'application/json' token
URL
http://some url here.com

GET api/v2/Organisation/{Slug}/Contacts/GetContact

Description: Return a list of contacts that meet a certain criteria Example: https://api.totalsynergy.com/api/v2/organisation/heya/Contacts/GetContact?ContactId=7
Required Parameters:
ContactId Long value to match a given contact
Response: 

{
  "id": 7,
  "contactTypeId": 0,
  "organisationId": 3,
  "organisation": null,
  "avatar": null,
  "parentContactID": 0,
  "isStaff": false,
  "staffTypeName": null,
  "phones": {
    "mobile": "0404 575 621",
    "phone": "9999 8888",
    "phone2": null,
    "phone3": null,
    "skypeName": null,
    "twitter": null,
    "linkedIn": null,
    "hasPhones": true
  },
  "timezoneId": null,
  "userCurrentDate": "2016-11-17T14:04:24.8284495",
  "rolesDisplay": "",
  "roleId": 0,
  "emailDomain": null,
  "web": null,
  "jobTitle": null,
  "name": "Radike Samo",
  "initials": "RS",
  "localTime": "Thu, Nov 17, 2016 - 2:04 PM",
  "salutationId": 0,
  "salutation": null,
  "firstName": "Radike",
  "lastName": "Samo",
  "email": "athlete@oldies.com",
  "cardId": "0006",
  "hasAddresses": true,
  "addressHome": {
    "id": 29,
    "address1": null,
    "address2": null,
    "town": null,
    "state": null,
    "zipCode": null,
    "country": null,
    "latitude": 0,
    "longitude": 0,
    "hasAddress": false,
    "singleline": ""
  },
  "addressWork": {
    "id": 32,
    "address1": "Pilfer Street, RugbyVille",
    "address2": null,
    "town": "ANZ Stadium",
    "state": "NSW",
    "zipCode": "2009",
    "country": "Australia",
    "latitude": 0,
    "longitude": 0,
    "hasAddress": true,
    "singleline": "Pilfer Street, RugbyVille, ANZ Stadium, NSW, 2009, Australia"
  },
  "addressPostal": {
    "id": 31,
    "address1": null,
    "address2": null,
    "town": null,
    "state": null,
    "zipCode": null,
    "country": "Australia",
    "latitude": 0,
    "longitude": 0,
    "hasAddress": false,
    "singleline": "Australia"
  },
  "addressOther": {
    "id": 30,
    "address1": null,
    "address2": null,
    "town": null,
    "state": null,
    "zipCode": null,
    "country": "Australia",
    "latitude": 0,
    "longitude": 0,
    "hasAddress": false,
    "singleline": "Australia"
  },
  "typeColumnDisplay": "",
  "typeDisplay": null,
  "website": null,
  "phoneDisplay": "9999 8888",
  "profileImageURL": null,
  "createdDate": "2016-06-24T00:00:00",
  "udpatedDate": "2016-06-24T00:00:00"
}

POST api/v2/Organisation/{Slug}/Contacts

Description: Creates a new contact Example: https://api.totalsynergy.com/api/v2/Organisation/testOrg/Contacts
Required Parameters:
FirstName string value of contacts first name
LastName string value of contacts last name
Name string value of contacts full name
Optional Parameters:
Web string value -contact's website
JobTitle string value - contact's job title
Email string value - contacts email
AddressHome AddressJson value containing detailed home address information
AddressWork AddressJson value containing detailed work address information
AddressPostal AddressJson value containing detailed postal address information
AddressOther AddressJson value containing detailed other address information
IsStaff boolean value to determine whether adding as staff member
Phones Phone containing different phone options and values
UserCurrentDate Date value - users local date
RoleId Long value to match a contact to a given role
ContactId Long value to match a given contact
Example Request: 

{
  "name": "Radike Samo",
  "firstName" : "Radike",
  "lastName" : "Samo",
  "jobTitle" : "Professional Tackler",
  "roleId" : 0,
  "phones" : {
  	"mobile" : "0404 575 621",
  	"phone" : "9999 8888"
  },
  "addressWork" : {
  	"address1" : "Pilfer Street, RugbyVille",
  	"state" : "NSW",
  	"town" : "ANZ Stadium",
  	"country" : "Australia",
  	"zipcode" : 2009
  },
  "typeDisplay": "Employee",
  "email": "athlete@oldies.com"
}
Response: 

{
  "id": 7,
  "contactTypeId": 0,
  "organisationId": 3,
  "organisation": null,
  "avatar": null,
  "parentContactID": 0,
  "isStaff": false,
  "staffTypeName": null,
  "phones": {
    "mobile": "0404 575 621",
    "phone": "9999 8888",
    "phone2": null,
    "phone3": null,
    "skypeName": null,
    "twitter": null,
    "linkedIn": null,
    "hasPhones": true
  },
  "timezoneId": null,
  "userCurrentDate": "2016-11-17T14:00:29.116924",
  "rolesDisplay": "",
  "roleId": 0,
  "emailDomain": null,
  "web": null,
  "jobTitle": null,
  "name": "Radike Samo",
  "initials": "RS",
  "localTime": "Thu, Nov 17, 2016 - 2:00 PM",
  "salutationId": 0,
  "salutation": null,
  "firstName": "Radike",
  "lastName": "Samo",
  "email": "athlete@oldies.com",
  "cardId": "0006",
  "hasAddresses": true,
  "addressHome": {
    "id": 29,
    "address1": null,
    "address2": null,
    "town": null,
    "state": null,
    "zipCode": null,
    "country": null,
    "latitude": 0,
    "longitude": 0,
    "hasAddress": false,
    "singleline": ""
  },
  "addressWork": {
    "id": 32,
    "address1": "Pilfer Street, RugbyVille",
    "address2": null,
    "town": "ANZ Stadium",
    "state": "NSW",
    "zipCode": "2009",
    "country": "Australia",
    "latitude": 0,
    "longitude": 0,
    "hasAddress": true,
    "singleline": "Pilfer Street, RugbyVille, ANZ Stadium, NSW, 2009, Australia"
  },
  "addressPostal": {
    "id": 31,
    "address1": null,
    "address2": null,
    "town": null,
    "state": null,
    "zipCode": null,
    "country": "Australia",
    "latitude": 0,
    "longitude": 0,
    "hasAddress": false,
    "singleline": "Australia"
  },
  "addressOther": {
    "id": 30,
    "address1": null,
    "address2": null,
    "town": null,
    "state": null,
    "zipCode": null,
    "country": "Australia",
    "latitude": 0,
    "longitude": 0,
    "hasAddress": false,
    "singleline": "Australia"
  },
  "typeColumnDisplay": "",
  "typeDisplay": null,
  "website": null,
  "phoneDisplay": "9999 8888",
  "profileImageURL": null
}

POST api/v2/Organisation/{Slug}/Contacts/Update

Description: Updates a contact Example: https://api.totalsynergy.com/api/v2/Organisation/testOrg/Contacts/Update
Required Parameters:
Id long value of contact to update Id
FirstName string value of contacts first name
LastName string value of contacts last name
Name string value of contacts full name
Optional Parameters:
Web string value -contact's website
JobTitle string value - contact's job title
Email string value - contacts email
AddressHome AddressJson value containing detailed home address information
AddressWork AddressJson value containing detailed work address information
AddressPostal AddressJson value containing detailed postal address information
AddressOther AddressJson value containing detailed other address information
IsStaff boolean value to determine whether adding as staff member
Phones Phone containing different phone options and values
UserCurrentDate Date value - users local date
RoleId Long value to match a contact to a given role
ContactId Long value to match a given contact
Example Request: 

{
  "id" : 15,
  "name": "Phillip Waugh",
  "lastName" : "Waugh",
  "organisationId" : 3,
}
Response: 

{
  "id": 15,
  "contactTypeId": 0,
  "organisationId": 3,
  "organisation": null,
  "avatar": null,
  "parentContactID": 0,
  "isStaff": true,
  "staffTypeName": null,
  "phones": {
    "mobile": null,
    "phone": null,
    "phone2": null,
    "phone3": null,
    "skypeName": null,
    "twitter": null,
    "linkedIn": null,
    "hasPhones": false
  },
  "timezoneId": null,
  "userCurrentDate": "2016-11-17T16:39:22.8652653",
  "rolesDisplay": "",
  "roleId": 0,
  "emailDomain": null,
  "web": null,
  "jobTitle": null,
  "name": "Phillip Waugh",
  "initials": "PW",
  "localTime": "Thu, Nov 17, 2016 - 4:39 PM",
  "salutationId": 0,
  "salutation": null,
  "firstName": null,
  "lastName": "Waugh",
  "email": null,
  "cardId": null,
  "hasAddresses": false,
  "addressHome": {
    "id": 41,
    "address1": null,
    "address2": null,
    "town": null,
    "state": null,
    "zipCode": null,
    "country": null,
    "latitude": 0,
    "longitude": 0,
    "hasAddress": false,
    "singleline": ""
  },
  "addressWork": {
    "id": 44,
    "address1": null,
    "address2": null,
    "town": null,
    "state": null,
    "zipCode": null,
    "country": null,
    "latitude": 0,
    "longitude": 0,
    "hasAddress": false,
    "singleline": ""
  },
  "addressPostal": {
    "id": 43,
    "address1": null,
    "address2": null,
    "town": null,
    "state": null,
    "zipCode": null,
    "country": null,
    "latitude": 0,
    "longitude": 0,
    "hasAddress": false,
    "singleline": ""
  },
  "addressOther": {
    "id": 42,
    "address1": null,
    "address2": null,
    "town": null,
    "state": null,
    "zipCode": null,
    "country": null,
    "latitude": 0,
    "longitude": 0,
    "hasAddress": false,
    "singleline": ""
  },
  "typeColumnDisplay": "",
  "typeDisplay": null,
  "website": null,
  "phoneDisplay": null,
  "profileImageURL": null
}

DELETE api/v2/Organisation/{Slug}/Contacts/Delete

Description: Deletes a contact Example: https://api.totalsynergy.com/api/v2/Organisation/testOrg/Contacts/Delete?ContactId=15 Parameters: long contactId* Response: 

"success"