Skip to main content

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.

API regionapi.whautomate.com

GET /v1/serviceCategories​

GET /v1/serviceCategories
Headers
x-api-keystringrequired
Your Whautomate API key.
Query parameters
locationIdstring
limitstring
pagestring
searchTextstring
Response 200
idstring
namestringrequired
locationobjectrequired
slugstring
createdAtstring
updatedAtstring
Request
curl -X GET "https://api.whautomate.com/v1/serviceCategories" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
[
  {
    "id": "string",
    "name": "string",
    "location": {
      "id": "string"
    },
    "slug": "string",
    "createdAt": "2025-01-01T10:00:00.000Z",
    "updatedAt": "2025-01-01T10:00:00.000Z"
  }
]

POST /v1/serviceCategories​

POST /v1/serviceCategories
Headers
x-api-keystringrequired
Your Whautomate API key.
Body
idstring
namestringrequired
locationobjectrequired
slugstring
createdAtstring
updatedAtstring
Response 200
idstring
namestringrequired
locationobjectrequired
slugstring
createdAtstring
updatedAtstring
Request
curl -X POST "https://api.whautomate.com/v1/serviceCategories" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "name": "string",
    "location": {
      "id": "string"
    },
    "slug": "string",
    "createdAt": "2025-01-01T10:00:00.000Z",
    "updatedAt": "2025-01-01T10:00:00.000Z"
  }'
Response 200
{
  "id": "string",
  "name": "string",
  "location": {
    "id": "string"
  },
  "slug": "string",
  "createdAt": "2025-01-01T10:00:00.000Z",
  "updatedAt": "2025-01-01T10:00:00.000Z"
}

GET /v1/serviceCategories/{serviceCategoryId}​

GET /v1/serviceCategories/{serviceCategoryId}
Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
serviceCategoryIdstringrequired
Response 200
idstring
namestringrequired
locationobjectrequired
slugstring
createdAtstring
updatedAtstring
Request
curl -X GET "https://api.whautomate.com/v1/serviceCategories/{serviceCategoryId}" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "id": "string",
  "name": "string",
  "location": {
    "id": "string"
  },
  "slug": "string",
  "createdAt": "2025-01-01T10:00:00.000Z",
  "updatedAt": "2025-01-01T10:00:00.000Z"
}

DELETE /v1/serviceCategories/{serviceCategoryId}​

DEL /v1/serviceCategories/{serviceCategoryId}
Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
serviceCategoryIdstringrequired
Response 200
successboolean
Request
curl -X DELETE "https://api.whautomate.com/v1/serviceCategories/{serviceCategoryId}" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "success": true
}
Last updated on