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
Query parameters
locationIdstringOptional
limitstringOptional
pagestringOptional
searchTextstringOptional
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
get
GET /v1/serviceCategories HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200

200 response

[
  {
    "id": "text",
    "name": "text",
    "location": {
      "id": "text"
    },
    "slug": "text",
    "createdAt": "2025-06-21T05:13:53.763Z",
    "updatedAt": "2025-06-21T05:13:53.763Z"
  }
]
post
Header parameters
x-api-keystringRequired
Body
idstringOptional
namestringRequired
slugstringOptional
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
Responses
200
200 response
application/json
post
POST /v1/serviceCategories HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "id": "text",
  "name": "text",
  "location": {
    "id": "text"
  },
  "slug": "text",
  "createdAt": "2025-06-21T05:13:53.763Z",
  "updatedAt": "2025-06-21T05:13:53.763Z"
}
200

200 response

{
  "id": "text",
  "name": "text",
  "location": {
    "id": "text"
  },
  "slug": "text",
  "createdAt": "2025-06-21T05:13:53.763Z",
  "updatedAt": "2025-06-21T05:13:53.763Z"
}
get
Path parameters
serviceCategoryIdstringRequired
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
get
GET /v1/serviceCategories/{serviceCategoryId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200

200 response

{
  "id": "text",
  "name": "text",
  "location": {
    "id": "text"
  },
  "slug": "text",
  "createdAt": "2025-06-21T05:13:53.763Z",
  "updatedAt": "2025-06-21T05:13:53.763Z"
}
delete
Path parameters
serviceCategoryIdstringRequired
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
delete
DELETE /v1/serviceCategories/{serviceCategoryId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200

200 response

{
  "success": true
}

Last updated