⚙️ Services

Service catalog and offerings management

List services

get

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

Get a paginated list of services with optional filters

Authorizations

sessionidstringRequired

Path parameters

org_uidstringRequired

Responses

200Success

application/json

Lightweight serializer for service lists.

unique_idstring · max: 100 · nullableOptional

namestringRead-onlyRequired

short_descriptionstringRead-onlyRequired

service_codestring · max: 100 · nullableOptional

service_typestring · enumOptional

• hourly - Hourly Service
• fixed - Fixed Price Service
• subscription - Subscription Service
• project - Project-based Service
• consultation - Consultation Service
• maintenance - Maintenance Service
• other - Other

Possible values:

categorystring · max: 200 · nullableOptional

hourly_ratestring · decimal · nullableOptional

Rate per hour for hourly services

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

fixed_pricestring · decimal · nullableOptional

Fixed price for the service

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

effective_ratestring · decimal · nullableRead-onlyRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

billing_cyclestring · enumOptional

• one_time - One Time
• hourly - Hourly
• daily - Daily
• weekly - Weekly
• monthly - Monthly
• quarterly - Quarterly
• annually - Annually

Possible values:

statusstring · enumOptional

• active - Active
• inactive - Inactive
• discontinued - Discontinued

Possible values:

date_createdstring · date-time · nullableOptional

401

Unauthorized

403

Forbidden

get/api/v1.0/organisation/{org_uid}/services/

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

[
  {
    "unique_id": "text",
    "name": "text",
    "short_description": "text",
    "service_code": "text",
    "service_type": "hourly",
    "category": "text",
    "hourly_rate": "text",
    "fixed_price": "text",
    "effective_rate": "text",
    "billing_cycle": "one_time",
    "status": "active",
    "date_created": "2026-01-01T00:00:00.000Z"
  }
]

Create service

post

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

Create a new service. service_type is required and must be one of: hourly, fixed, subscription, project, consultation, maintenance, or other.

Authorizations

sessionidstringRequired

Path parameters

org_uidstringRequired

Body

Full serializer for Service creation and updates. Handles translatable fields correctly.

namestring · min: 1 · max: 300Required

descriptionstring · nullableOptional

short_descriptionstring · max: 500 · nullableOptional

service_codestring · max: 100 · nullableOptional

service_typestring · enumRequired

Service type: hourly, fixed, subscription, project, consultation, maintenance, or other

• hourly - Hourly Service
• fixed - Fixed Price Service
• subscription - Subscription Service
• project - Project-based Service
• consultation - Consultation Service
• maintenance - Maintenance Service
• other - Other

Possible values:

categorystring · max: 200 · nullableOptional

hourly_ratestring · decimal · nullableOptional

Rate per hour for hourly services

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

fixed_pricestring · decimal · nullableOptional

Fixed price for the service

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

billing_cyclestring · enumOptional

• one_time - One Time
• hourly - Hourly
• daily - Daily
• weekly - Weekly
• monthly - Monthly
• quarterly - Quarterly
• annually - Annually

Possible values:

estimated_duration_hoursstring · decimal · nullableOptional

Estimated time to complete the service

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

statusstring · enumOptional

• active - Active
• inactive - Inactive
• discontinued - Discontinued

Possible values:

requirementsstring · nullableOptional

Responses

201Success

application/json

Detailed serializer for single service retrieval.

unique_idstring · max: 100 · nullableOptional

namestringRead-onlyRequired

descriptionstringRead-onlyRequired

short_descriptionstringRead-onlyRequired

service_codestring · max: 100 · nullableOptional

service_typestring · enumOptional

• hourly - Hourly Service
• fixed - Fixed Price Service
• subscription - Subscription Service
• project - Project-based Service
• consultation - Consultation Service
• maintenance - Maintenance Service
• other - Other

Possible values:

categorystring · max: 200 · nullableOptional

hourly_ratestring · decimal · nullableOptional

Rate per hour for hourly services

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

fixed_pricestring · decimal · nullableOptional

Fixed price for the service

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

effective_ratestring · decimal · nullableRead-onlyRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

billing_cyclestring · enumOptional

• one_time - One Time
• hourly - Hourly
• daily - Daily
• weekly - Weekly
• monthly - Monthly
• quarterly - Quarterly
• annually - Annually

Possible values:

estimated_duration_hoursstring · decimal · nullableOptional

Estimated time to complete the service

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

statusstring · enumOptional

• active - Active
• inactive - Inactive
• discontinued - Discontinued

Possible values:

requirementsstring · nullableOptional

date_createdstring · date-time · nullableOptional

last_updatedstring · date-time · nullableOptional

400

Bad Request

401

Unauthorized

403

Forbidden

post/api/v1.0/organisation/{org_uid}/services/create/

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

{
  "name": "text",
  "description": "text",
  "short_description": "text",
  "service_code": "text",
  "service_type": "hourly",
  "category": "text",
  "hourly_rate": "text",
  "fixed_price": "text",
  "billing_cycle": "one_time",
  "estimated_duration_hours": "text",
  "status": "active",
  "requirements": "text"
}

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "short_description": "text",
  "service_code": "text",
  "service_type": "hourly",
  "category": "text",
  "hourly_rate": "text",
  "fixed_price": "text",
  "effective_rate": "text",
  "billing_cycle": "one_time",
  "estimated_duration_hours": "text",
  "status": "active",
  "requirements": "text",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}

Retrieve service

get

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

Get detailed information about a specific service

Authorizations

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Responses

200Success

application/json

Detailed serializer for single service retrieval.

unique_idstring · max: 100 · nullableOptional

namestringRead-onlyRequired

descriptionstringRead-onlyRequired

short_descriptionstringRead-onlyRequired

service_codestring · max: 100 · nullableOptional

service_typestring · enumOptional

• hourly - Hourly Service
• fixed - Fixed Price Service
• subscription - Subscription Service
• project - Project-based Service
• consultation - Consultation Service
• maintenance - Maintenance Service
• other - Other

Possible values:

categorystring · max: 200 · nullableOptional

hourly_ratestring · decimal · nullableOptional

Rate per hour for hourly services

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

fixed_pricestring · decimal · nullableOptional

Fixed price for the service

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

effective_ratestring · decimal · nullableRead-onlyRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

billing_cyclestring · enumOptional

• one_time - One Time
• hourly - Hourly
• daily - Daily
• weekly - Weekly
• monthly - Monthly
• quarterly - Quarterly
• annually - Annually

Possible values:

estimated_duration_hoursstring · decimal · nullableOptional

Estimated time to complete the service

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

statusstring · enumOptional

• active - Active
• inactive - Inactive
• discontinued - Discontinued

Possible values:

requirementsstring · nullableOptional

date_createdstring · date-time · nullableOptional

last_updatedstring · date-time · nullableOptional

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v1.0/organisation/{org_uid}/services/{unique_id}/

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

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "short_description": "text",
  "service_code": "text",
  "service_type": "hourly",
  "category": "text",
  "hourly_rate": "text",
  "fixed_price": "text",
  "effective_rate": "text",
  "billing_cycle": "one_time",
  "estimated_duration_hours": "text",
  "status": "active",
  "requirements": "text",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}

Update service

put

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

Update service information (PUT for full update, PATCH for partial)

Authorizations

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Body

Full serializer for Service creation and updates. Handles translatable fields correctly.

namestring · min: 1 · max: 300Required

descriptionstring · nullableOptional

short_descriptionstring · max: 500 · nullableOptional

service_codestring · max: 100 · nullableOptional

service_typestring · enumRequired

Service type: hourly, fixed, subscription, project, consultation, maintenance, or other

• hourly - Hourly Service
• fixed - Fixed Price Service
• subscription - Subscription Service
• project - Project-based Service
• consultation - Consultation Service
• maintenance - Maintenance Service
• other - Other

Possible values:

categorystring · max: 200 · nullableOptional

hourly_ratestring · decimal · nullableOptional

Rate per hour for hourly services

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

fixed_pricestring · decimal · nullableOptional

Fixed price for the service

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

billing_cyclestring · enumOptional

• one_time - One Time
• hourly - Hourly
• daily - Daily
• weekly - Weekly
• monthly - Monthly
• quarterly - Quarterly
• annually - Annually

Possible values:

estimated_duration_hoursstring · decimal · nullableOptional

Estimated time to complete the service

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

statusstring · enumOptional

• active - Active
• inactive - Inactive
• discontinued - Discontinued

Possible values:

requirementsstring · nullableOptional

Responses

200Success

application/json

Detailed serializer for single service retrieval.

unique_idstring · max: 100 · nullableOptional

namestringRead-onlyRequired

descriptionstringRead-onlyRequired

short_descriptionstringRead-onlyRequired

service_codestring · max: 100 · nullableOptional

service_typestring · enumOptional

• hourly - Hourly Service
• fixed - Fixed Price Service
• subscription - Subscription Service
• project - Project-based Service
• consultation - Consultation Service
• maintenance - Maintenance Service
• other - Other

Possible values:

categorystring · max: 200 · nullableOptional

hourly_ratestring · decimal · nullableOptional

Rate per hour for hourly services

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

fixed_pricestring · decimal · nullableOptional

Fixed price for the service

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

effective_ratestring · decimal · nullableRead-onlyRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

billing_cyclestring · enumOptional

• one_time - One Time
• hourly - Hourly
• daily - Daily
• weekly - Weekly
• monthly - Monthly
• quarterly - Quarterly
• annually - Annually

Possible values:

estimated_duration_hoursstring · decimal · nullableOptional

Estimated time to complete the service

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

statusstring · enumOptional

• active - Active
• inactive - Inactive
• discontinued - Discontinued

Possible values:

requirementsstring · nullableOptional

date_createdstring · date-time · nullableOptional

last_updatedstring · date-time · nullableOptional

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

put/api/v1.0/organisation/{org_uid}/services/{unique_id}/update/

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

{
  "name": "text",
  "description": "text",
  "short_description": "text",
  "service_code": "text",
  "service_type": "hourly",
  "category": "text",
  "hourly_rate": "text",
  "fixed_price": "text",
  "billing_cycle": "one_time",
  "estimated_duration_hours": "text",
  "status": "active",
  "requirements": "text"
}

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "short_description": "text",
  "service_code": "text",
  "service_type": "hourly",
  "category": "text",
  "hourly_rate": "text",
  "fixed_price": "text",
  "effective_rate": "text",
  "billing_cycle": "one_time",
  "estimated_duration_hours": "text",
  "status": "active",
  "requirements": "text",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}

Update service

patch

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

Update service information (PUT for full update, PATCH for partial)

Authorizations

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Body

Full serializer for Service creation and updates. Handles translatable fields correctly.

namestring · min: 1 · max: 300Optional

descriptionstring · nullableOptional

short_descriptionstring · max: 500 · nullableOptional

service_codestring · max: 100 · nullableOptional

service_typestring · enumOptional

Service type: hourly, fixed, subscription, project, consultation, maintenance, or other

• hourly - Hourly Service
• fixed - Fixed Price Service
• subscription - Subscription Service
• project - Project-based Service
• consultation - Consultation Service
• maintenance - Maintenance Service
• other - Other

Possible values:

categorystring · max: 200 · nullableOptional

hourly_ratestring · decimal · nullableOptional

Rate per hour for hourly services

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

fixed_pricestring · decimal · nullableOptional

Fixed price for the service

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

billing_cyclestring · enumOptional

• one_time - One Time
• hourly - Hourly
• daily - Daily
• weekly - Weekly
• monthly - Monthly
• quarterly - Quarterly
• annually - Annually

Possible values:

estimated_duration_hoursstring · decimal · nullableOptional

Estimated time to complete the service

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

statusstring · enumOptional

• active - Active
• inactive - Inactive
• discontinued - Discontinued

Possible values:

requirementsstring · nullableOptional

Responses

200Success

application/json

Detailed serializer for single service retrieval.

unique_idstring · max: 100 · nullableOptional

namestringRead-onlyRequired

descriptionstringRead-onlyRequired

short_descriptionstringRead-onlyRequired

service_codestring · max: 100 · nullableOptional

service_typestring · enumOptional

• hourly - Hourly Service
• fixed - Fixed Price Service
• subscription - Subscription Service
• project - Project-based Service
• consultation - Consultation Service
• maintenance - Maintenance Service
• other - Other

Possible values:

categorystring · max: 200 · nullableOptional

hourly_ratestring · decimal · nullableOptional

Rate per hour for hourly services

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

fixed_pricestring · decimal · nullableOptional

Fixed price for the service

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

effective_ratestring · decimal · nullableRead-onlyRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

billing_cyclestring · enumOptional

• one_time - One Time
• hourly - Hourly
• daily - Daily
• weekly - Weekly
• monthly - Monthly
• quarterly - Quarterly
• annually - Annually

Possible values:

estimated_duration_hoursstring · decimal · nullableOptional

Estimated time to complete the service

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

statusstring · enumOptional

• active - Active
• inactive - Inactive
• discontinued - Discontinued

Possible values:

requirementsstring · nullableOptional

date_createdstring · date-time · nullableOptional

last_updatedstring · date-time · nullableOptional

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

patch/api/v1.0/organisation/{org_uid}/services/{unique_id}/update/

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

{
  "name": "text",
  "description": "text",
  "short_description": "text",
  "service_code": "text",
  "service_type": "hourly",
  "category": "text",
  "hourly_rate": "text",
  "fixed_price": "text",
  "billing_cycle": "one_time",
  "estimated_duration_hours": "text",
  "status": "active",
  "requirements": "text"
}

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "short_description": "text",
  "service_code": "text",
  "service_type": "hourly",
  "category": "text",
  "hourly_rate": "text",
  "fixed_price": "text",
  "effective_rate": "text",
  "billing_cycle": "one_time",
  "estimated_duration_hours": "text",
  "status": "active",
  "requirements": "text",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}

Perform action on service

get

/api/v1.0/organisation/{org_uid}/services/{unique_id}/action/

Perform actions on a service (duplicate, deactivate). Uses query parameters.

Authorizations

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Query parameters

actionstring · enumRequired

Action to perform: duplicate or deactivate

Possible values:

Responses

200Success

application/json

Detailed serializer for single service retrieval.

unique_idstring · max: 100 · nullableOptional

namestringRead-onlyRequired

descriptionstringRead-onlyRequired

short_descriptionstringRead-onlyRequired

service_codestring · max: 100 · nullableOptional

service_typestring · enumOptional

• hourly - Hourly Service
• fixed - Fixed Price Service
• subscription - Subscription Service
• project - Project-based Service
• consultation - Consultation Service
• maintenance - Maintenance Service
• other - Other

Possible values:

categorystring · max: 200 · nullableOptional

hourly_ratestring · decimal · nullableOptional

Rate per hour for hourly services

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

fixed_pricestring · decimal · nullableOptional

Fixed price for the service

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

effective_ratestring · decimal · nullableRead-onlyRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

billing_cyclestring · enumOptional

• one_time - One Time
• hourly - Hourly
• daily - Daily
• weekly - Weekly
• monthly - Monthly
• quarterly - Quarterly
• annually - Annually

Possible values:

estimated_duration_hoursstring · decimal · nullableOptional

Estimated time to complete the service

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

statusstring · enumOptional

• active - Active
• inactive - Inactive
• discontinued - Discontinued

Possible values:

requirementsstring · nullableOptional

date_createdstring · date-time · nullableOptional

last_updatedstring · date-time · nullableOptional

400

Bad Request - Invalid action

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v1.0/organisation/{org_uid}/services/{unique_id}/action/

GET /api/v1.0/organisation/{org_uid}/services/{unique_id}/action/?action=deactivate HTTP/1.1
Host: skhokho.ai
Accept: */*

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "short_description": "text",
  "service_code": "text",
  "service_type": "hourly",
  "category": "text",
  "hourly_rate": "text",
  "fixed_price": "text",
  "effective_rate": "text",
  "billing_cycle": "one_time",
  "estimated_duration_hours": "text",
  "status": "active",
  "requirements": "text",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}