GET Weekly Availability

Changed on

/employees/:user/availabilities/weekly Permission level: 5

get/employees/{user}/availabilities/weekly

Request

  • Base URL
    https://www.humanity.com/api/v2
  • Auth
    API key in query parameter access_token

Path parameters

userinteger required

Employee ID

Query parameters

approvedinteger

0 or 1<br>If set to 0, non approved weekly availability intervals will be returned.<br>If set to 1, and if the setting <i>Availability must be approved by management</i> is enabled, approved weekly availability intervals will be returned.

dayinteger

If set, it will return weekly availability intervals for the given day only.<br>Accepted values: enum [1,2,3,4,5,6,7].<br>1 - Sunday<br>2 - Monday<br>3 - Tuesday<br>4 - Wednesday<br>5 - Thursday<br>6 - Friday<br>7 - Saturday

timeframeinteger

0 or 1<br>Has effect only if the setting<br>"Availability Change Requests are effective"<br>is not set to "Immediately".<br>When set to 1, <i>effective</i> date will be shown in the response.

Response

200

statusinteger
tokenstring
errorunknown

Example response

{
  "status": 1,
  "data": {
    "effective": "2018-04-03 13:23:44",
    "type": 1,
    "grid": {
      "id": "3",
      "day": "Tue",
      "availability": {
        "5": {
          "flag": "2"
        },
        "6": {
          "flag": "2"
        },
        "7": {
          "flag": "2"
        },
        "8": {
          "flag": "2"
        },
        "9": {
          "flag": "2"
        },
        "10": {
          "flag": "2"
        },
        "11": {
          "flag": "2"
        },
        "12": {
          "flag": "2"
        },
        "13": {
          "flag": "1"
        },
        "14": {
          "flag": "1"
        },
        "15": {
          "flag": "1"
        },
        "16": {
          "flag": "1"
        },
        "17": {
          "flag": "1"
        },
        "18": {
          "flag": "1"
        },
        "19": {
          "flag": "1"
        },
        "20": {
          "flag": "1"
        },
        "21": {
          "flag": "1"
        },
        "22": {
          "flag": "1"
        },
        "23": {
          "flag": "1"
        },
        "24": {
          "flag": "1"
        },
        "25": {
          "flag": "1"
        },
        "26": {
          "flag": "1"
        },
        "27": {
          "flag": "1"
        },
        "28": {
          "flag": "1"
        },
        "29": {
          "flag": "1"
        },
        "30": {
          "flag": "1"
        },
        "31": {
          "flag": "1"
        },
        "32": {
          "flag": "1"
        },
        "33": {
          "flag": "1"
        },
        "34": {
          "flag": "1"
        },
        "35": {
          "flag": "1"
        },
        "36": {
          "flag": "1"
        },
        "37": {
          "flag": "1"
        },
        "38": {
          "flag": "1"
        },
        "39": {
          "flag": "1"
        },
        "40": {
          "flag": "1"
        },
        "41": {
          "flag": "1"
        },
        "42": {
          "flag": "1"
        },
        "43": {
          "flag": "1"
        },
        "44": {
          "flag": "1"
        }
      }
    }
  },
  "token": "xxxxxxx"
}

Changes