Service Categories

This API documentation provides a comprehensive guide for interacting with the service categories. This system allows you to manage categories that can be associated with your services.

This API offers functionalities to:

• Create new service categories.

• Read existing service categories, including retrieving a single category or a list of categories based on specific criteria.

• Delete service categories that are no longer required.

By leveraging this API, you can efficiently manage your service categories, ensuring a well-organized and user-friendly service catalogue in Whautomate.

get

/v1/serviceCategories

Query parameters

locationIdstring

limitstring

pagestring

searchTextstring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '<YOUR HOST>/v1/serviceCategories' \
  --header 'x-api-key: text'

200

200

[
  {
    "id": "text",
    "name": "text",
    "slug": "text",
    "createdAt": "2025-02-23T08:28:31.126Z",
    "updatedAt": "2025-02-23T08:28:31.126Z",
    "location": {
      "id": "text"
    }
  }
]

200 response

post

/v1/serviceCategories

Header parameters

x-api-keystringrequired

Body

idstring

namestringrequired

slugstring

createdAtstring · date-time

updatedAtstring · date-time

locationobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '<YOUR HOST>/v1/serviceCategories' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","location":{"id":"text"}}'

200

200

{
  "id": "text",
  "name": "text",
  "slug": "text",
  "createdAt": "2025-02-23T08:28:31.126Z",
  "updatedAt": "2025-02-23T08:28:31.126Z",
  "location": {
    "id": "text"
  }
}

200 response

get

/v1/serviceCategories/{serviceCategoryId}

Path parameters

serviceCategoryIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '<YOUR HOST>/v1/serviceCategories/{serviceCategoryId}' \
  --header 'x-api-key: text'

200

200

{
  "id": "text",
  "name": "text",
  "slug": "text",
  "createdAt": "2025-02-23T08:28:31.126Z",
  "updatedAt": "2025-02-23T08:28:31.126Z",
  "location": {
    "id": "text"
  }
}

200 response

delete

/v1/serviceCategories/{serviceCategoryId}

Path parameters

serviceCategoryIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '<YOUR HOST>/v1/serviceCategories/{serviceCategoryId}' \
  --header 'x-api-key: text'

200

200

{
  "success": true
}

200 response