Skip to main content

Service Categories

Service categories group your services on the booking page and in the app. Creating and deleting categories needs the Bookings or Sales add-on.

API regionapi.whautomate.com

List service categories​

GET /v1/serviceCategories

Lists service categories.

Headers
x-api-keystringrequired
Your Whautomate API key.
Query parameters
locationIdstring
Location (workspace) id. Get ids from GET /v1/locations.
limitinteger
Results per page (default 10, max 100).
pageinteger
Page number, from 1 (default 1).
searchTextstring
Text to search for.
Response 200
idstring
namestringrequired
locationobjectrequired
slugstring
createdAtstring
updatedAtstring
sortOrderinteger
Request
curl -X GET "https://api.whautomate.com/v1/serviceCategories?locationId=Le6dWjQF9K&limit=3" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
[
  {
    "id": "yOXg3zyowJ",
    "name": "Consultation",
    "location": {
      "id": "Le6dWjQF9K"
    },
    "slug": "consultation",
    "sortOrder": 1,
    "createdAt": "2026-10-29T11:42:14.861Z",
    "updatedAt": "2026-10-29T11:42:14.861Z"
  },
  {
    "id": "B4mud5rTUb",
    "name": "Trial Session",
    "location": {
      "id": "Le6dWjQF9K"
    },
    "slug": "trial-session",
    "sortOrder": 2,
    "createdAt": "2026-10-29T11:42:14.873Z",
    "updatedAt": "2026-10-29T11:42:14.873Z"
  }
]

Create a service category​

POST /v1/serviceCategories

Creates a service category.

Headers
x-api-keystringrequired
Your Whautomate API key.
Body
idstring
namestringrequired
locationobjectrequired
slugstring
createdAtstring
updatedAtstring
Response 200
idstring
namestringrequired
locationobjectrequired
slugstring
createdAtstring
updatedAtstring
sortOrderinteger
Request
curl -X POST "https://api.whautomate.com/v1/serviceCategories" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Massage Therapies",
    "location": {
      "id": "Le6dWjQF9K"
    }
  }'
Response 201
{
  "id": "cdhuKUEBmF",
  "name": "Massage Therapies",
  "location": {
    "id": "Le6dWjQF9K",
    "title": "Serene Wellness Studio",
    "addressLine1": "22 Duxton Road",
    "addressLine2": null,
    "postalCode": "089485",
    "city": "Singapore",
    "district": null,
    "slug": "serene-wellness-studio",
    "status": "Pending",
    "isFeatured": false,
    "createdAt": "2026-10-29T11:42:14.856Z",
    "updatedAt": "2026-10-29T12:39:40.395Z",
    "appointment": {
      "id": "9BAnCsCETF"
    },
    "services": [
      {
        "objectId": "RY8J6LNLTm"
      },
      {
        "objectId": "OMxTMXqCLB"
      },
      {
        "objectId": "THF7D9KbDa"
      }
    ],
    "categories": [
      {
        "objectId": "SDNLMuyyx9"
      },
      {
        "objectId": "8gCIo04c5y"
      }
    ],
    "countryCode": "+65",
    "description": "Serene Wellness Studio in the heart of Singapore.",
    "facebook": null,
    "formIndex": 1,
    "instagram": null,
    "linkedin": null,
    "phone": "61234567",
    "postCodeStart": 8,
    "tags": [],
    "twitter": null,
    "website": null,
    "youtube": null,
    "completedSteps": [
      "mobile-app",
      "whatsapp-payment-method"
    ]
  },
  "createdAt": "2026-10-29T12:40:09.321Z",
  "sortOrder": 12,
  "slug": "massage-therapies",
  "updatedAt": "2026-10-29T12:40:09.321Z"
}

Get a service category​

GET /v1/serviceCategories/{serviceCategoryId}

Gets one service category by id.

Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
serviceCategoryIdstringrequired
Response 200
idstring
namestringrequired
locationobjectrequired
slugstring
createdAtstring
updatedAtstring
sortOrderinteger
Request
curl -X GET "https://api.whautomate.com/v1/serviceCategories/cdhuKUEBmF" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "id": "cdhuKUEBmF",
  "name": "Massage Therapies",
  "location": {
    "id": "Le6dWjQF9K"
  },
  "sortOrder": 12,
  "slug": "massage-therapies",
  "createdAt": "2026-10-29T12:40:09.321Z",
  "updatedAt": "2026-10-29T12:40:09.321Z"
}

Delete a service category​

DEL /v1/serviceCategories/{serviceCategoryId}

Deletes a service category.

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