Search contact record

Request

GET https://api.aptania.com/services/contact/getContact

Search for an existing contact record

Query parameters

Parameter name Value Description Additional
tokenUUID String Unique api token used for each request. Required
contactUUID String Identified user value. Required

Example Request 

https://api.aptania.com/services/contact/getContact?tokenUUID=xxxxxxxx-xxx-xxxx-xxxx-xxxxxxxxxxx&contactUUID=xxxxxxxx-xxx-xxxx-xxxx-xxxxxxxxxxx

Response body

Parameter name Value Description
contactTitle String The title for the contact.
contactFirstname String The firstname for the contact.
contactLastname String The lastname for the contact.
contactEmailaddress String The emailaddress for the contact.
contactTelephone String The telephone number for the contact.
contactJobRole String The job role for the contact.
contactProfileID String The profile ID for the contact.
contactTagID JSON object Object describing all of the tags added and available for a contact.
status String The http status code for the reponse.

Example Response 

            
                                {
                                   "contact":    {
                                      "contactTitle": "",
                                      "contactFirstname": "",
                                      "contactLastname": "",
                                      "contactEmailaddress": "john.doe@xxxxxxx.com",
                                      "contactTelephone": "",
                                      "contactMobile": "",
                                      "contactJobRole": "",
                                      "contactProfileID": "xxx",
                                      "contactProfileName": "Sign Up",
                                      "tag":       [
                                                  {
                                            "tagID": "xxx",
                                            "tagName": "Newsletter",
                                            "opt": true
                                         },
                                                  {
                                            "tagID": "xxx",
                                            "tagName": "Events",
                                            "opt": true
                                         },
                                                  {
                                            "tagID": "xxx",
                                            "tagName": "Promotions",
                                            "opt": true
                                         }
                                      ],
                                      "contactStatus": "active"
                                   },
                                   "status": "200"
                                }

To use this api you must have an account together with an api key. Please contact us for further information.