🤝 Clients

Client and customer relationship management

List clients

get

https://skhokho.aihttp://102.209.118.152:8000/https://dev.skhokho.ai

/api/v1.0/organisation/{org_uid}/clients/

Get a list of all clients with optional filters

Authorizations

cookieAuthbasicAuth

sessionidstringRequired

Path parameters

org_uidstringRequired

Query parameters

company_sizestringOptional

Filter by company size

entity_typestring · enumOptional

Filter by entity type

Possible values:

industrystring · enumOptional

Filter by industry

Possible values:

lifecycle_stagestring · enumOptional

Filter by client lifecycle stage

Possible values:

searchstringOptional

Search clients by name

Responses

200Success

application/json

401

Unauthorized

403

Forbidden

get

/api/v1.0/organisation/{org_uid}/clients/

HTTPcURLJavaScriptPython

GET /api/v1.0/organisation/{org_uid}/clients/ HTTP/1.1
Host: skhokho.ai
Accept: */*

[
  {
    "unique_id": "text",
    "name": "text",
    "description": "text",
    "entity_type": "individual",
    "entity_type_display": "text",
    "lifecycle_stage": "prospect",
    "lifecycle_stage_display": "text",
    "industry": "agriculture",
    "industry_display": "text",
    "website": "https://example.com",
    "company_size": "text",
    "annual_revenue": "text",
    "default_currency": "text",
    "first_contact_date": "2026-02-04",
    "last_contact_date": "2026-02-04",
    "next_follow_up_date": "2026-02-04",
    "created_by": {
      "unique_id": "text",
      "full_name": "text"
    },
    "assigned_to": {
      "unique_id": "text",
      "full_name": "text"
    },
    "account_owner": {
      "unique_id": "text",
      "full_name": "text"
    },
    "address": {
      "address_line_1": "text",
      "address_line_2": "text",
      "city": "text",
      "province_state": "text",
      "postal_code": "text",
      "country": "text",
      "phone": "text"
    },
    "banking_information": {
      "bank_name": "text",
      "account_number": "text",
      "branch_code": "text",
      "account_type": "checking",
      "routing_number": "text",
      "swift_code": "text"
    },
    "days_since_last_contact": 1,
    "is_follow_up_overdue": true,
    "primary_contact": {
      "unique_id": "text",
      "first_name": "text",
      "last_name": "text",
      "name": "text",
      "email": "[email protected]",
      "phone": "text",
      "job_title": "text",
      "primary_contact": true,
      "is_active": true,
      "entity_type": "client",
      "entity_id": "text"
    },
    "date_created": "2026-02-04T19:55:05.895Z",
    "last_updated": "2026-02-04T19:55:05.895Z"
  }
]

Create client

post

https://skhokho.aihttp://102.209.118.152:8000/https://dev.skhokho.ai

/api/v1.0/organisation/{org_uid}/clients/create/

Create a new client. Client name is required.

Authorizations

cookieAuthbasicAuth

sessionidstringRequired

Path parameters

org_uidstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Comprehensive serializer for Client model. Handles multilingual fields, nested relationships, and computed fields. Optimized for list and detail views with optional prefetching support.

unique_idstring · max: 100 · nullableOptional

namestring · min: 1 · max: 300Required

descriptionstring · nullableOptional

entity_typestring · enumOptional

• individual - Individual
• company - Company
• non_profit - Non-Profit Organization
• government - Government Entity
• partnership - Partnership
• other - Other

Possible values:

lifecycle_stagestring · enumOptional

• prospect - Prospect
• active_client - Active Client
• matured_client - Matured Client
• inactive - Inactive
• dormant - Dormant
• lost_opportunity - Lost Opportunity

Possible values:

industrystring · enum · nullableOptional

• agriculture - Agriculture and Farming
• cleaning - Cleaning Services
• construction - Construction and Real Estate Services
• consulting - Consulting and Freelancing
• creative - Creative and Design Services
• education - Education and Tutoring Services
• events - Entertainment and Events Planning
• handyman - Handyman and Home Repair Services
• health - Health and Wellness
• home_based - Home-Based Businesses
• hospitality - Hospitality and Tourism
• it_support - IT and Software Support Services
• legal - Legal and Financial Services
• logistics - Logistics and Delivery Services
• manufacturing - Manufacturing and Small-Scale Production
• marketing - Marketing and Advertising Services
• music - Music and Entertainment Services
• non_profit - Non-Profit and Social Enterprises
• online_retail - Online Retail and E-commerce
• photography - Photography and Videography Services
• printing - Printing and Copy Services
• professional - Professional Services
• travel - Travel Agencies
• utilities - Utilities and Renewable Energy Services
• wholesale - Wholesale and Distribution
• writing - Writing and Editing Services
• virtual_assistance - Virtual Assistance and Admin Support
• other - Other

Possible values:

websitestring · uri · max: 300 · nullableOptional

company_sizestring · max: 100 · nullableOptional

annual_revenuestring · decimal · nullableOptional

Annual revenue in USD

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$

default_currencystring · min: 1 · max: 3Optional

Default currency code (ISO 4217) for this entity's transactions

first_contact_datestring · date · nullableOptional

last_contact_datestring · date · nullableOptional

next_follow_up_datestring · date · nullableOptional

Responses

201Success

application/json

400

Bad Request - Invalid input or missing required fields

401

Unauthorized

403

Forbidden

post

/api/v1.0/organisation/{org_uid}/clients/create/

HTTPcURLJavaScriptPython

POST /api/v1.0/organisation/{org_uid}/clients/create/ HTTP/1.1
Host: skhokho.ai
Content-Type: application/json
Accept: */*
Content-Length: 651

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "entity_type": "individual",
  "lifecycle_stage": "prospect",
  "industry": "agriculture",
  "website": "https://example.com",
  "company_size": "text",
  "annual_revenue": "text",
  "default_currency": "text",
  "first_contact_date": "2026-02-04",
  "last_contact_date": "2026-02-04",
  "next_follow_up_date": "2026-02-04",
  "address": {
    "address_line_1": "text",
    "address_line_2": "text",
    "city": "text",
    "province_state": "text",
    "postal_code": "text",
    "country": "text",
    "phone": "text"
  },
  "banking_information": {
    "bank_name": "text",
    "account_number": "text",
    "branch_code": "text",
    "account_type": "checking",
    "routing_number": "text",
    "swift_code": "text"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "entity_type": "individual",
  "entity_type_display": "text",
  "lifecycle_stage": "prospect",
  "lifecycle_stage_display": "text",
  "industry": "agriculture",
  "industry_display": "text",
  "website": "https://example.com",
  "company_size": "text",
  "annual_revenue": "text",
  "default_currency": "text",
  "first_contact_date": "2026-02-04",
  "last_contact_date": "2026-02-04",
  "next_follow_up_date": "2026-02-04",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "assigned_to": {
    "unique_id": "text",
    "full_name": "text"
  },
  "account_owner": {
    "unique_id": "text",
    "full_name": "text"
  },
  "address": {
    "address_line_1": "text",
    "address_line_2": "text",
    "city": "text",
    "province_state": "text",
    "postal_code": "text",
    "country": "text",
    "phone": "text"
  },
  "banking_information": {
    "bank_name": "text",
    "account_number": "text",
    "branch_code": "text",
    "account_type": "checking",
    "routing_number": "text",
    "swift_code": "text"
  },
  "days_since_last_contact": 1,
  "is_follow_up_overdue": true,
  "primary_contact": {
    "unique_id": "text",
    "first_name": "text",
    "last_name": "text",
    "name": "text",
    "email": "[email protected]",
    "phone": "text",
    "job_title": "text",
    "primary_contact": true,
    "is_active": true,
    "entity_type": "client",
    "entity_id": "text"
  },
  "date_created": "2026-02-04T19:55:05.895Z",
  "last_updated": "2026-02-04T19:55:05.895Z"
}

Get client

get

https://skhokho.aihttp://102.209.118.152:8000/https://dev.skhokho.ai

/api/v1.0/organisation/{org_uid}/clients/{unique_id}/

Retrieve a specific client

Authorizations

cookieAuthbasicAuth

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Responses

200Success

application/json

401

Unauthorized

403

Forbidden

404

Not Found

get

/api/v1.0/organisation/{org_uid}/clients/{unique_id}/

HTTPcURLJavaScriptPython

GET /api/v1.0/organisation/{org_uid}/clients/{unique_id}/ HTTP/1.1
Host: skhokho.ai
Accept: */*

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "entity_type": "individual",
  "entity_type_display": "text",
  "lifecycle_stage": "prospect",
  "lifecycle_stage_display": "text",
  "industry": "agriculture",
  "industry_display": "text",
  "website": "https://example.com",
  "company_size": "text",
  "annual_revenue": "text",
  "default_currency": "text",
  "first_contact_date": "2026-02-04",
  "last_contact_date": "2026-02-04",
  "next_follow_up_date": "2026-02-04",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "assigned_to": {
    "unique_id": "text",
    "full_name": "text"
  },
  "account_owner": {
    "unique_id": "text",
    "full_name": "text"
  },
  "address": {
    "address_line_1": "text",
    "address_line_2": "text",
    "city": "text",
    "province_state": "text",
    "postal_code": "text",
    "country": "text",
    "phone": "text"
  },
  "banking_information": {
    "bank_name": "text",
    "account_number": "text",
    "branch_code": "text",
    "account_type": "checking",
    "routing_number": "text",
    "swift_code": "text"
  },
  "days_since_last_contact": 1,
  "is_follow_up_overdue": true,
  "primary_contact": {
    "unique_id": "text",
    "first_name": "text",
    "last_name": "text",
    "name": "text",
    "email": "[email protected]",
    "phone": "text",
    "job_title": "text",
    "primary_contact": true,
    "is_active": true,
    "entity_type": "client",
    "entity_id": "text"
  },
  "date_created": "2026-02-04T19:55:05.895Z",
  "last_updated": "2026-02-04T19:55:05.895Z"
}

Update client

put

https://skhokho.aihttp://102.209.118.152:8000/https://dev.skhokho.ai

/api/v1.0/organisation/{org_uid}/clients/{unique_id}/update/

Update a specific client (full or partial update)

Authorizations

cookieAuthbasicAuth

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Comprehensive serializer for Client model. Handles multilingual fields, nested relationships, and computed fields. Optimized for list and detail views with optional prefetching support.

unique_idstring · max: 100 · nullableOptional

namestring · min: 1 · max: 300Required

descriptionstring · nullableOptional

entity_typestring · enumOptional

• individual - Individual
• company - Company
• non_profit - Non-Profit Organization
• government - Government Entity
• partnership - Partnership
• other - Other

Possible values:

lifecycle_stagestring · enumOptional

• prospect - Prospect
• active_client - Active Client
• matured_client - Matured Client
• inactive - Inactive
• dormant - Dormant
• lost_opportunity - Lost Opportunity

Possible values:

industrystring · enum · nullableOptional

• agriculture - Agriculture and Farming
• cleaning - Cleaning Services
• construction - Construction and Real Estate Services
• consulting - Consulting and Freelancing
• creative - Creative and Design Services
• education - Education and Tutoring Services
• events - Entertainment and Events Planning
• handyman - Handyman and Home Repair Services
• health - Health and Wellness
• home_based - Home-Based Businesses
• hospitality - Hospitality and Tourism
• it_support - IT and Software Support Services
• legal - Legal and Financial Services
• logistics - Logistics and Delivery Services
• manufacturing - Manufacturing and Small-Scale Production
• marketing - Marketing and Advertising Services
• music - Music and Entertainment Services
• non_profit - Non-Profit and Social Enterprises
• online_retail - Online Retail and E-commerce
• photography - Photography and Videography Services
• printing - Printing and Copy Services
• professional - Professional Services
• travel - Travel Agencies
• utilities - Utilities and Renewable Energy Services
• wholesale - Wholesale and Distribution
• writing - Writing and Editing Services
• virtual_assistance - Virtual Assistance and Admin Support
• other - Other

Possible values:

websitestring · uri · max: 300 · nullableOptional

company_sizestring · max: 100 · nullableOptional

annual_revenuestring · decimal · nullableOptional

Annual revenue in USD

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$

default_currencystring · min: 1 · max: 3Optional

Default currency code (ISO 4217) for this entity's transactions

first_contact_datestring · date · nullableOptional

last_contact_datestring · date · nullableOptional

next_follow_up_datestring · date · nullableOptional

Responses

200Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

put

/api/v1.0/organisation/{org_uid}/clients/{unique_id}/update/

HTTPcURLJavaScriptPython

PUT /api/v1.0/organisation/{org_uid}/clients/{unique_id}/update/ HTTP/1.1
Host: skhokho.ai
Content-Type: application/json
Accept: */*
Content-Length: 651

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "entity_type": "individual",
  "lifecycle_stage": "prospect",
  "industry": "agriculture",
  "website": "https://example.com",
  "company_size": "text",
  "annual_revenue": "text",
  "default_currency": "text",
  "first_contact_date": "2026-02-04",
  "last_contact_date": "2026-02-04",
  "next_follow_up_date": "2026-02-04",
  "address": {
    "address_line_1": "text",
    "address_line_2": "text",
    "city": "text",
    "province_state": "text",
    "postal_code": "text",
    "country": "text",
    "phone": "text"
  },
  "banking_information": {
    "bank_name": "text",
    "account_number": "text",
    "branch_code": "text",
    "account_type": "checking",
    "routing_number": "text",
    "swift_code": "text"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "entity_type": "individual",
  "entity_type_display": "text",
  "lifecycle_stage": "prospect",
  "lifecycle_stage_display": "text",
  "industry": "agriculture",
  "industry_display": "text",
  "website": "https://example.com",
  "company_size": "text",
  "annual_revenue": "text",
  "default_currency": "text",
  "first_contact_date": "2026-02-04",
  "last_contact_date": "2026-02-04",
  "next_follow_up_date": "2026-02-04",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "assigned_to": {
    "unique_id": "text",
    "full_name": "text"
  },
  "account_owner": {
    "unique_id": "text",
    "full_name": "text"
  },
  "address": {
    "address_line_1": "text",
    "address_line_2": "text",
    "city": "text",
    "province_state": "text",
    "postal_code": "text",
    "country": "text",
    "phone": "text"
  },
  "banking_information": {
    "bank_name": "text",
    "account_number": "text",
    "branch_code": "text",
    "account_type": "checking",
    "routing_number": "text",
    "swift_code": "text"
  },
  "days_since_last_contact": 1,
  "is_follow_up_overdue": true,
  "primary_contact": {
    "unique_id": "text",
    "first_name": "text",
    "last_name": "text",
    "name": "text",
    "email": "[email protected]",
    "phone": "text",
    "job_title": "text",
    "primary_contact": true,
    "is_active": true,
    "entity_type": "client",
    "entity_id": "text"
  },
  "date_created": "2026-02-04T19:55:05.895Z",
  "last_updated": "2026-02-04T19:55:05.895Z"
}

Update client

patch

https://skhokho.aihttp://102.209.118.152:8000/https://dev.skhokho.ai

/api/v1.0/organisation/{org_uid}/clients/{unique_id}/update/

Update a specific client (full or partial update)

Authorizations

cookieAuthbasicAuth

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Comprehensive serializer for Client model. Handles multilingual fields, nested relationships, and computed fields. Optimized for list and detail views with optional prefetching support.

unique_idstring · max: 100 · nullableOptional

namestring · min: 1 · max: 300Optional

descriptionstring · nullableOptional

entity_typestring · enumOptional

• individual - Individual
• company - Company
• non_profit - Non-Profit Organization
• government - Government Entity
• partnership - Partnership
• other - Other

Possible values:

lifecycle_stagestring · enumOptional

• prospect - Prospect
• active_client - Active Client
• matured_client - Matured Client
• inactive - Inactive
• dormant - Dormant
• lost_opportunity - Lost Opportunity

Possible values:

industrystring · enum · nullableOptional

• agriculture - Agriculture and Farming
• cleaning - Cleaning Services
• construction - Construction and Real Estate Services
• consulting - Consulting and Freelancing
• creative - Creative and Design Services
• education - Education and Tutoring Services
• events - Entertainment and Events Planning
• handyman - Handyman and Home Repair Services
• health - Health and Wellness
• home_based - Home-Based Businesses
• hospitality - Hospitality and Tourism
• it_support - IT and Software Support Services
• legal - Legal and Financial Services
• logistics - Logistics and Delivery Services
• manufacturing - Manufacturing and Small-Scale Production
• marketing - Marketing and Advertising Services
• music - Music and Entertainment Services
• non_profit - Non-Profit and Social Enterprises
• online_retail - Online Retail and E-commerce
• photography - Photography and Videography Services
• printing - Printing and Copy Services
• professional - Professional Services
• travel - Travel Agencies
• utilities - Utilities and Renewable Energy Services
• wholesale - Wholesale and Distribution
• writing - Writing and Editing Services
• virtual_assistance - Virtual Assistance and Admin Support
• other - Other

Possible values:

websitestring · uri · max: 300 · nullableOptional

company_sizestring · max: 100 · nullableOptional

annual_revenuestring · decimal · nullableOptional

Annual revenue in USD

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$

default_currencystring · min: 1 · max: 3Optional

Default currency code (ISO 4217) for this entity's transactions

first_contact_datestring · date · nullableOptional

last_contact_datestring · date · nullableOptional

next_follow_up_datestring · date · nullableOptional

Responses

200Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

patch

/api/v1.0/organisation/{org_uid}/clients/{unique_id}/update/

HTTPcURLJavaScriptPython

PATCH /api/v1.0/organisation/{org_uid}/clients/{unique_id}/update/ HTTP/1.1
Host: skhokho.ai
Content-Type: application/json
Accept: */*
Content-Length: 651

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "entity_type": "individual",
  "lifecycle_stage": "prospect",
  "industry": "agriculture",
  "website": "https://example.com",
  "company_size": "text",
  "annual_revenue": "text",
  "default_currency": "text",
  "first_contact_date": "2026-02-04",
  "last_contact_date": "2026-02-04",
  "next_follow_up_date": "2026-02-04",
  "address": {
    "address_line_1": "text",
    "address_line_2": "text",
    "city": "text",
    "province_state": "text",
    "postal_code": "text",
    "country": "text",
    "phone": "text"
  },
  "banking_information": {
    "bank_name": "text",
    "account_number": "text",
    "branch_code": "text",
    "account_type": "checking",
    "routing_number": "text",
    "swift_code": "text"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "entity_type": "individual",
  "entity_type_display": "text",
  "lifecycle_stage": "prospect",
  "lifecycle_stage_display": "text",
  "industry": "agriculture",
  "industry_display": "text",
  "website": "https://example.com",
  "company_size": "text",
  "annual_revenue": "text",
  "default_currency": "text",
  "first_contact_date": "2026-02-04",
  "last_contact_date": "2026-02-04",
  "next_follow_up_date": "2026-02-04",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "assigned_to": {
    "unique_id": "text",
    "full_name": "text"
  },
  "account_owner": {
    "unique_id": "text",
    "full_name": "text"
  },
  "address": {
    "address_line_1": "text",
    "address_line_2": "text",
    "city": "text",
    "province_state": "text",
    "postal_code": "text",
    "country": "text",
    "phone": "text"
  },
  "banking_information": {
    "bank_name": "text",
    "account_number": "text",
    "branch_code": "text",
    "account_type": "checking",
    "routing_number": "text",
    "swift_code": "text"
  },
  "days_since_last_contact": 1,
  "is_follow_up_overdue": true,
  "primary_contact": {
    "unique_id": "text",
    "first_name": "text",
    "last_name": "text",
    "name": "text",
    "email": "[email protected]",
    "phone": "text",
    "job_title": "text",
    "primary_contact": true,
    "is_active": true,
    "entity_type": "client",
    "entity_id": "text"
  },
  "date_created": "2026-02-04T19:55:05.895Z",
  "last_updated": "2026-02-04T19:55:05.895Z"
}

Delete client

delete

https://skhokho.aihttp://102.209.118.152:8000/https://dev.skhokho.ai

/api/v1.0/organisation/{org_uid}/clients/{unique_id}/delete/

Delete a specific client

Authorizations

cookieAuthbasicAuth

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

delete

/api/v1.0/organisation/{org_uid}/clients/{unique_id}/delete/

HTTPcURLJavaScriptPython

DELETE /api/v1.0/organisation/{org_uid}/clients/{unique_id}/delete/ HTTP/1.1
Host: skhokho.ai
Accept: */*

No content