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<YOUR HOST>/v1/serviceCategories

Query parameters

Header parameters

Response

200

200 response

Body

application/json

idstring

name*string

location*object

slugstring

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/serviceCategories', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "name": "text",
    "location": {
      "id": "text"
    },
    "slug": "text",
    "createdAt": "2024-12-21T12:30:56.552Z",
    "updatedAt": "2024-12-21T12:30:56.552Z"
  }
]

POST<YOUR HOST>/v1/serviceCategories

Header parameters

Body

application/json

idstring

name*string

location*object

slugstring

createdAtstring (date-time)

updatedAtstring (date-time)

Response

200

200 response

Body

application/json

idstring

name*string

location*object

slugstring

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/serviceCategories', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "location": {
        "id": "text"
      },
      "name": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "location": {
    "id": "text"
  },
  "slug": "text",
  "createdAt": "2024-12-21T12:30:56.552Z",
  "updatedAt": "2024-12-21T12:30:56.552Z"
}

GET<YOUR HOST>/v1/serviceCategories/{serviceCategoryId}

Path parameters

serviceCategoryId*string

Header parameters

Response

200

200 response

Body

application/json

idstring

name*string

location*object

slugstring

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/serviceCategories/{serviceCategoryId}', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "location": {
    "id": "text"
  },
  "slug": "text",
  "createdAt": "2024-12-21T12:30:56.552Z",
  "updatedAt": "2024-12-21T12:30:56.552Z"
}

DELETE<YOUR HOST>/v1/serviceCategories/{serviceCategoryId}

Path parameters

serviceCategoryId*string

Header parameters

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/serviceCategories/{serviceCategoryId}', {
    method: 'DELETE',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "success": false
}