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

GEThttps://<YOUR HOST>/v1/staffs

Query parameters

Header parameters

Response

200

200 response

Body

application/json

idstring

firstName*string

lastNamestring

emailstring

genderenum

MaleFemaleUnknownOther

countryCodestring

phone*string

activeboolean

locations*array of string

Request

JavaScriptCurlPython

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

Response

200

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

Get Staff By Id

GEThttps://<YOUR HOST>/v1/staffs/{staffId}

Path parameters

staffId*string

Header parameters

Response

200

200 response

Body

application/json

idstring

firstName*string

lastNamestring

emailstring

genderenum

MaleFemaleUnknownOther

countryCodestring

phone*string

activeboolean

locations*array of string

Request

JavaScriptCurlPython

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

Response

200

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

Retrieve Staff's availability blocks based on date range

GET<YOUR HOST>/v1/staffs/{staffId}/availabilityBlocks

Path parameters

staffId*string

Query parameters

Header parameters

Response

200

200 response

Body

application/json

idstring

staff*object

timezonestring

date*string (date)

slots*array of object

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "id": "text",
    "staff": {
      "id": "text",
      "firstName": "text",
      "lastName": "text"
    },
    "timezone": "text",
    "date": "2024-11-21",
    "slots": [
      {
        "startTime": "text",
        "startTimeUTC": "text",
        "endTime": "text",
        "endTimeUTC": "text"
      }
    ]
  }
]

Block Staff's time

POST<YOUR HOST>/v1/staffs/{staffId}/availabilityBlocks

Path parameters

staffId*string

Header parameters

Body

application/json

idstring

staff*object

timezonestring

date*string (date)

slots*array of object

Response

200

200 response

Body

application/json

idstring

staff*object

timezonestring

date*string (date)

slots*array of object

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/staffs/{staffId}/availabilityBlocks', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "date": "2024-11-21",
      "slots": [
        {
          "endTime": "text",
          "startTime": "text"
        }
      ],
      "staff": {
        "id": "text"
      }
    }),
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "staff": {
      "id": "text",
      "firstName": "text",
      "lastName": "text"
    },
    "timezone": "text",
    "date": "2024-11-21",
    "slots": [
      {
        "startTime": "text",
        "startTimeUTC": "text",
        "endTime": "text",
        "endTimeUTC": "text"
      }
    ]
  }
]

Get Availibility Block By Id

GET<YOUR HOST>/v1/staffs/{staffId}/availabilityBlocks/{availabilityBlockId}

Path parameters

staffId*string

availabilityBlockId*string

Header parameters

Response

200

200 response

Body

application/json

idstring

staff*object

timezonestring

date*string (date)

slots*array of object

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "staff": {
    "id": "text",
    "firstName": "text",
    "lastName": "text"
  },
  "timezone": "text",
  "date": "2024-11-21",
  "slots": [
    {
      "startTime": "text",
      "startTimeUTC": "text",
      "endTime": "text",
      "endTimeUTC": "text"
    }
  ]
}

Delete Staff's Blocked Time By Id

DELETE<YOUR HOST>/v1/staffs/{staffId}/availabilityBlocks/{availabilityBlockId}

Path parameters

staffId*string

availabilityBlockId*string

Header parameters

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

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

Response

200

{
  "success": false
}