⚙️ 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
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_uid}/services/

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
post
/api/v1.0/organisation/{org_uid}/services/create/

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
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_uid}/services/{unique_id}/

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
chevron-right
200Success
application/json
put
/api/v1.0/organisation/{org_uid}/services/{unique_id}/update/

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
chevron-right
200Success
application/json
patch
/api/v1.0/organisation/{org_uid}/services/{unique_id}/update/

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
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_uid}/services/{unique_id}/action/

Last updated