Classes

This API documentation provides a comprehensive guide for interacting with the class management system in Whautomate. This allows you to interact using API and sync classes between multiple systems.

Here's a breakdown of the functionalities offered:

• Search or Retrieve Classes (GET /v1/classes): This method allows you to find specific classes or retrieve a full list. You can optionally filter the results based on various criteria (e.g., date range, location, instructor).

• Get Individual Class By Id (GET /v1/classes/{classId}): Use this method to retrieve detailed information about a particular class by providing its unique identifier.

• Create a New Class (POST /v1/classes): This method enables you to create new classes by specifying details like date, time, location, instructor, service (type of class), and any other relevant information.

• Update Class (PUT /v1/classes/{classId}): Modify details of an existing class using this method. You can update information like date, time, instructor, or other relevant attributes.

• Delete Class By Id (DELETE /v1/classes/{classId}): This method allows you to permanently remove a class from the schedule.

• Get Participants of a Class (GET /v1/classes/{classId}/participants): Retrieve a list of participants enrolled in a specific class by providing its unique identifier.

• Add Participant to Class (POST /v1/classes/{classId}/participants/add): This method allows you to enroll participants in a specific class.

• Remove Participant from Class (POST /v1/classes/{classId}/participants/cancel): Use this method to cancel a participant's enrollment from a specific class.

• Get Class bookings of a Client (GET /v1/classes/clients/{clientId}/bookings): Use this method to get all the classes booked by a particular client using their Id.

By leveraging this API, you can streamline your class management process, ensuring a clear and organized class schedule along with efficient participant management.

Search or retrieve Classes

get

/v1/classes

Query parameters

limitstring

staffIdstring

endDatestring

locationIdstring

pagestring

startDatestring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

[
  {
    "id": "text",
    "timezone": "text",
    "date": "2025-02-23",
    "time": "text",
    "startTimeUTC": "2025-02-23T08:53:14.641Z",
    "startTime": "2025-02-23T08:53:14.641Z",
    "endTimeUTC": "2025-02-23T08:53:14.641Z",
    "endTime": "2025-02-23T08:53:14.641Z",
    "bookedParticipants": 1,
    "numberOfParticipants": 1,
    "status": "text",
    "createdAt": "2025-02-23T08:53:14.641Z",
    "updatedAt": "2025-02-23T08:53:14.641Z",
    "location": {
      "id": "text",
      "title": "text"
    },
    "staff": {
      "id": "text",
      "name": "text"
    },
    "service": {
      "id": "text",
      "name": "text",
      "durationMinutes": 1,
      "sellingPrice": 1
    }
  }
]

200 response

Get Individual Class By Id

get

/v1/classes/{classId}

Path parameters

classIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "id": "text",
  "timezone": "text",
  "date": "2025-02-23",
  "time": "text",
  "startTimeUTC": "2025-02-23T08:53:14.641Z",
  "startTime": "2025-02-23T08:53:14.641Z",
  "endTimeUTC": "2025-02-23T08:53:14.641Z",
  "endTime": "2025-02-23T08:53:14.641Z",
  "bookedParticipants": 1,
  "numberOfParticipants": 1,
  "status": "text",
  "createdAt": "2025-02-23T08:53:14.641Z",
  "updatedAt": "2025-02-23T08:53:14.641Z",
  "location": {
    "id": "text",
    "title": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "service": {
    "id": "text",
    "name": "text",
    "durationMinutes": 1,
    "sellingPrice": 1
  }
}

200 response

Create a new Class

post

/v1/classes

Header parameters

x-api-keystringrequired

Body

datestringrequired

Date of the class in YYYY-MM-DD format

timestringrequired

Time of the class

numberOfParticipantsinteger

Number of participants in the class (optional)

timezonestring

Timezone of the class (optional)

locationobjectrequired

staffobjectrequired

serviceobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "id": "text",
  "timezone": "text",
  "date": "2025-02-23",
  "time": "text",
  "startTimeUTC": "2025-02-23T08:53:14.641Z",
  "startTime": "2025-02-23T08:53:14.641Z",
  "endTimeUTC": "2025-02-23T08:53:14.641Z",
  "endTime": "2025-02-23T08:53:14.641Z",
  "bookedParticipants": 1,
  "numberOfParticipants": 1,
  "status": "text",
  "createdAt": "2025-02-23T08:53:14.641Z",
  "updatedAt": "2025-02-23T08:53:14.641Z",
  "location": {
    "id": "text",
    "title": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "service": {
    "id": "text",
    "name": "text",
    "durationMinutes": 1,
    "sellingPrice": 1
  }
}

200 response

Update Class

put

/v1/classes/{classId}

Path parameters

classIdstringrequired

Header parameters

x-api-keystringrequired

Body

datestringrequired

Date of the class in YYYY-MM-DD format

timestringrequired

Time of the class

numberOfParticipantsinteger

Number of participants in the class (optional)

timezonestring

Timezone of the class (optional)

locationobjectrequired

staffobjectrequired

serviceobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '<YOUR HOST>/v1/classes/{classId}' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"date":"text","time":"text","location":{"id":"text"},"staff":{"id":"text"},"service":{"id":"text"}}'

200

200

{
  "id": "text",
  "timezone": "text",
  "date": "2025-02-23",
  "time": "text",
  "startTimeUTC": "2025-02-23T08:53:14.641Z",
  "startTime": "2025-02-23T08:53:14.641Z",
  "endTimeUTC": "2025-02-23T08:53:14.641Z",
  "endTime": "2025-02-23T08:53:14.641Z",
  "bookedParticipants": 1,
  "numberOfParticipants": 1,
  "status": "text",
  "createdAt": "2025-02-23T08:53:14.641Z",
  "updatedAt": "2025-02-23T08:53:14.641Z",
  "location": {
    "id": "text",
    "title": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "service": {
    "id": "text",
    "name": "text",
    "durationMinutes": 1,
    "sellingPrice": 1
  }
}

200 response

Delete Class By Id

delete

/v1/classes/{classId}

Path parameters

classIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "success": true
}

200 response

Get Participants of a Class

get

/v1/classes/{classId}/participants

Path parameters

classIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

[
  {
    "id": "text",
    "paymentStatus": "text",
    "status": "text",
    "createdAt": "2025-02-23T08:53:14.641Z",
    "updatedAt": "2025-02-23T08:53:14.641Z",
    "client": {
      "id": "text",
      "fullName": "text"
    }
  }
]

200 response

Add Participant to Class

post

/v1/classes/{classId}/participants/add

Path parameters

classIdstringrequired

Header parameters

x-api-keystringrequired

Body

statusstring · enum

Client's booking status (optional)

Options: BOOKED, WAITLISTED

clientobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '<YOUR HOST>/v1/classes/{classId}/participants/add' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"status":"BOOKED","client":{}}'

200

200

{
  "id": "text",
  "paymentStatus": "text",
  "status": "text",
  "createdAt": "2025-02-23T08:53:14.641Z",
  "updatedAt": "2025-02-23T08:53:14.641Z",
  "client": {
    "id": "text",
    "fullName": "text"
  }
}

200 response

Remove Participant from Class

post

/v1/classes/{classId}/participants/cancel

Path parameters

classIdstringrequired

Header parameters

x-api-keystringrequired

Body

participantIdstringrequired

Unique identifier for the participant

cancellationReasonstring

Reason for cancellation provided by the participant (optional)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '<YOUR HOST>/v1/classes/{classId}/participants/cancel' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"participantId":"text"}'

200

200

{
  "id": "text",
  "paymentStatus": "text",
  "status": "text",
  "createdAt": "2025-02-23T08:53:14.641Z",
  "updatedAt": "2025-02-23T08:53:14.641Z",
  "client": {
    "id": "text",
    "fullName": "text"
  }
}

200 response

Get Class Bookings of Particular Client

get

/v1/classes/clients/{clientId}/bookings

Authorizations

Path parameters

clientIdstringrequired

Query parameters

limitstring

endDatestring

locationIdstring

pagestring

startDatestring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://<YOUR HOST>/v1/classes/clients/{clientId}/bookings' \
  --header 'x-api-key: text'

200

200

[
  {
    "id": "text",
    "paymentStatus": "text",
    "status": "text",
    "createdAt": "2025-02-23T08:53:14.641Z",
    "updatedAt": "2025-02-23T08:53:14.641Z",
    "client": {
      "id": "text",
      "fullName": "text"
    },
    "class": {
      "id": "text",
      "timezone": "text",
      "date": "2025-02-23",
      "time": "text",
      "startTimeUTC": "2025-02-23T08:53:14.641Z",
      "startTime": "2025-02-23T08:53:14.641Z",
      "endTimeUTC": "2025-02-23T08:53:14.641Z",
      "endTime": "2025-02-23T08:53:14.641Z",
      "bookedParticipants": 1,
      "numberOfParticipants": 1,
      "status": "text",
      "createdAt": "2025-02-23T08:53:14.641Z",
      "updatedAt": "2025-02-23T08:53:14.641Z",
      "location": {
        "id": "text",
        "title": "text"
      },
      "staff": {
        "id": "text",
        "name": "text"
      },
      "service": {
        "id": "text",
        "name": "text",
        "durationMinutes": 1,
        "sellingPrice": 1
      }
    }
  }
]

200 response