Contacts

The contacts endpoint url is:

https://skhokho.io/api/v1.0/contacts

Contacts GET Request

Contact GET request will fetch a list of contacts associated with the company of the user who is currently authenticated. The structure of the list will be:

[
  {
    "id": 756,
    "contactFirstName": "Aegon",
    "contactLastName": "Targaryen",
    "contactPhoneNumber": "02345435436653",
    "contactEmailAddress": "aegon@houseofdragon.com",
    "contactWebsite": "https://skhokho.io",
    "contactJobDescription": "King of Westeros",
    "contactTwitter": "https://twitter.com",
    "contactFacebook": "https://facebook.com",
    "contactLinkedIn": "https://linkedin.com",
    "companyName": "House of Dragon",
    "contactInstagram": "https://instagram.com",
    "addressLine1": "1 Church Streeet",
    "city": "Johannesburg",
    "province": "Gauteng",
    "country": "South Africa",
    "postalCode": "2122",
    "uniqueId": "xxxxxxxxxxxxx"
    },
    . . . . . // Other Results
]

Contacts POST Request

When you want to create a new contacts record, you can send a POST request to the contacts end-point.

Contacts Payload Example:

{
  "contactFirstName": "Aegon",
  "contactLastName": "Targaryen",
  "contactPhoneNumber": "02345435436653",
  "contactEmailAddress": "aegon@houseofdragon.com",
  "contactWebsite": "https://skhokho.io",
  "contactJobDescription": "King of Westeros",
  "contactTwitter": "https://twitter.com",
  "contactFacebook": "https://facebook.com",
  "contactLinkedIn": "https://linkedin.com",
  "companyName": "House of Dragon",
  "contactInstagram": "https://instagram.com",
  "addressLine1": "1 Church Streeet",
  "city": "Johannesburg",
  "province": "Gauteng",
  "country": "South Africa",
  "postalCode": "2122",
}

Field	Required/Optional	Json Key	Data Type
First Name	Required	contactFirstName	string
Last Name	Required	contactLastName	string
Phone Number	Optional	contactPhoneNumber	string
Email Address	Required	contactEmailAddress	string
Website	Optional	contactWebsite	string
Job Description	Optional	contactJobDescription	string
Twitter Url	Optional	contactTwitter	string
Facebook Url	Optional	contactFacebook	string
LinkedIn Url	Optional	contactLinkedIn	string
Instagram Url	Optional	contactInstagram	string
Company Name	Optional	companyName	string
Address Line 1	Optional	addressLine1	string
City	Optional	city	string
Province/State	Optional	province	string
Country	Optional	country	string
Postal Code	Optional	postalCode	string