Staffs

This section provides comprehensive documentation regarding staff management functionalities within Whautomate.

Explore the methods available to retrieve staff lists and access detailed information about individual staff members within your organization.

Retrieve Staffs: Obtain a list of staff members available within your Whautomate account, enabling access to information about the personnel associated with your organization.

Get Staff By ID: Retrieve detailed information about a specific staff member using their unique identifier (staffId), facilitating targeted access to individual staff profiles and their specific details within the platform.

Retrieve Staff's Blocked Time Based on Date Range: This method allows you to view a staff member's blocked time schedule for a specific date range. By providing the staff's unique identifier and desired date range, you can identify periods marked as unavailable due to leaves, or personal commitments.

Block Staff's Time: This method enables you to create blocked time slots on a staff member's schedule. Use this functionality to mark specific times as unavailable. You can create these blocks by providing the staff's ID and details about the blocked time period (date, time range).

Get Blocked Time By Id: Use this method to retrieve detailed information about a specific blocked time slot within a staff member's schedule. Provide the staff ID and the unique identifier of the blocked time to access details.

Delete Staff's Blocked Time By Id: This method allows you to remove a previously created blocked time period from a staff member's schedule. Use the staff ID and the unique identifier of the blocked time for deletion.

Retrieve Staffs

get

/v1/staffs

Query parameters

locationIdstring

limitstring

pagestring

searchTextstring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

[
  {
    "id": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "countryCode": "text",
    "phone": "text",
    "active": true,
    "gender": "Male",
    "locations": [
      "text"
    ]
  }
]

200 response

Get Staff By Id

get

/v1/staffs/{staffId}

Path parameters

staffIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "id": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "countryCode": "text",
  "phone": "text",
  "active": true,
  "gender": "Male",
  "locations": [
    "text"
  ]
}

200 response

Retrieve Staff's availability blocks based on date range

get

/v1/staffs/{staffId}/availabilityBlocks

Path parameters

staffIdstringrequired

Query parameters

startDatestring

endDatestring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

[
  {
    "id": "text",
    "timezone": "text",
    "date": "2025-02-23",
    "staff": {
      "id": "text",
      "firstName": "text",
      "lastName": "text"
    },
    "slots": [
      {
        "startTime": "text",
        "startTimeUTC": "text",
        "endTime": "text",
        "endTimeUTC": "text"
      }
    ]
  }
]

200 response

Block Staff's time

post

/v1/staffs/{staffId}/availabilityBlocks

Path parameters

staffIdstringrequired

Header parameters

x-api-keystring

Body

idstring

timezonestring

datestring · daterequired

staffobjectrequired

slotsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '<YOUR HOST>/v1/staffs/{staffId}/availabilityBlocks' \
  --header 'Content-Type: application/json' \
  --data '{"date":"2025-02-23","staff":{"id":"text","firstName":"text","lastName":"text"},"slots":[{"startTime":"text","startTimeUTC":"text","endTime":"text","endTimeUTC":"text"}]}'

200

200

[
  {
    "id": "text",
    "timezone": "text",
    "date": "2025-02-23",
    "staff": {
      "id": "text",
      "firstName": "text",
      "lastName": "text"
    },
    "slots": [
      {
        "startTime": "text",
        "startTimeUTC": "text",
        "endTime": "text",
        "endTimeUTC": "text"
      }
    ]
  }
]

200 response

Get Availibility Block By Id

get

/v1/staffs/{staffId}/availabilityBlocks/{availabilityBlockId}

Path parameters

staffIdstringrequired

availabilityBlockIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '<YOUR HOST>/v1/staffs/{staffId}/availabilityBlocks/{availabilityBlockId}' \
  --header 'x-api-key: text'

200

200

{
  "id": "text",
  "timezone": "text",
  "date": "2025-02-23",
  "staff": {
    "id": "text",
    "firstName": "text",
    "lastName": "text"
  },
  "slots": [
    {
      "startTime": "text",
      "startTimeUTC": "text",
      "endTime": "text",
      "endTimeUTC": "text"
    }
  ]
}

200 response

Delete Staff's Blocked Time By Id

delete

/v1/staffs/{staffId}/availabilityBlocks/{availabilityBlockId}

Path parameters

staffIdstringrequired

availabilityBlockIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '<YOUR HOST>/v1/staffs/{staffId}/availabilityBlocks/{availabilityBlockId}' \
  --header 'x-api-key: text'

200

200

{
  "success": true
}

200 response