Skhokho API

# Clients

The clients endpoint url is:

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

# Clients GET Request

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

[
  {
    "id": 17,
    "companyName": "Construction Lorem",
    "companyEmail": "aryastark70@gmail.com",
    "companyPhone": "+27 67 221 8834",
    "companyTaxNumber": "128373747",
    "companyWebsite": "https://skhokho.io",
    "companySize": "Medium Sized",
    "companyIndustry": "Construction",
    "addressLine1": "1 Church Streeet",
    "city": "Johannesburg",
    "state": "Gauteng",
    "country": "South Africa",
    "postalCode": "2122",
    "twitter": "https://twitter.com",
    "facebook": "https://facebook.com",
    "linkedIn": "https://linkedin.com",
    "uniqueId": "xxxxxxxxxxxx"
    },
    . . . . . // Other Results
]

# Clients POST Request

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

Clients Payload Example:

{
  "companyName": "Construction Lorem",
  "companyEmail": "aryastark70@gmail.com",
  "companyPhone": "+27 67 221 8834",
  "companyTaxNumber": "128373747",
  "companyWebsite": "https://skhokho.io",
  "companySize": "Medium Sized",
  "companyIndustry": "Construction",
  "addressLine1": "1 Church Streeet",
  "city": "Johannesburg",
  "state": "Gauteng",
  "country": "South Africa",
  "postalCode": "2122",
  "twitter": "https://twitter.com",
  "facebook": "https://facebook.com",
  "linkedIn": "https://linkedin.com"
}
Field Required/Optional Json Key Data Type
Company Name Required companyName string
Company Email Required companyEmail string
Company Phone Required companyPhone string
Company Tax Number Optional companyTaxNumber string
Company Website Optional companyWebsite string
Company Size Optional companySize string/**fixed_options
Company Industry Optional companyIndustry string/**fixed_options
Address Line 1 Optional addressLine1 string
City Optional city string
State Optional state string
Country Optional country string
Postal Code Optional postalCode string
Twitter Optional twitter string
Facebook Optional facebook string
Linked In Optional linkedIn string

** Company Size Fixed Options

[
  'Entrepreneur Only',
  'Start up',
  'Small Business',
  'Scale up',
  'Medium Sized',
  'Big Company',
  'Corporate',
  'Government',
]

** Company Industry Fixed Options

[
  'Agriculture',
  'Biotechnology',
  'Business Products & Services',
  'Clean Technology',
  'Computers',
  'Consumer Products & Services',
  'Construction',
  'Education',
  'Energy',
  'Engineering',
  'Entertainment',
  'Electronics/Instrumentation',
  'Fashion',
  'Financial Services',
  'Food/Drink',
  'Gaming',
  'Government',
  'Healthcare Services',
  'Hospitality',
  'Industrial/Energy',
  'Lifestyle',
  'Legal Practice',
  'Manufacturing',
  'Marketing/Advertising',
  'Media & Entertainment',
  'Medical Devices & Equipment',
  'Mining',
  'Non-Profit',
  'Nanotechnology',
  'Networking & Equipment',
  'Pharmaceutical',
  'Property',
  'Retail/Distribution',
  'Software',
  'Sports',
  'Telecommunications',
  'Travel',
  'Tourism',
  'Transport',
  'Other',
]

← Products and Services →