/employees Permission level: 7

get/employees

Request

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

Query parameters

scheduleinteger

Position ID. Parameter for filtering purpose. If set, only employees assigned on that position will be fetched.

locationinteger

Location ID

disabledinteger

enum [1] -> 1: Return disabled employees

inactiveinteger

enum [1] -> 1: Return inactive employees

with_custom_fieldsinteger

enum[0,1] -> 0: Do not retrieve employee custom fields; 1: Retrieve employee custom fields

scheduler_usersinteger

enum [1] -> 1: Retrieves staff user that can see on schedule if staff gallery is off

check_permissioninteger

enum [1]

fields[employee]'id' | 'avatar' | 'legacy_avatar' | 'avatar_url' | 'name' | 'p_phone' | 'p_email' | 'cell_phone' | 'home_phone' | 'email' | 'group_name' | 'status_name' | 'vendor_id' | 'schedules' | 'skills' | 'registered' | 'last_active' | 'birth_day' | 'birth_month' | 'birth_year' | 'work_start_date' | 'location' | 'state' | 'city' | 'zip' | 'nick_name' | 'username' | 'address' | 'include_skill_data'

Multiple values can be used, separated by commas. Using include_skill_data with skills expands the skill response to include name and expiration data.

Response

200

statusinteger
tokenstring

Example response

{
  "status": 1,
  "data": [
    {
      "id": "2736727",
      "work_start_date": "2016-07-29 16:37:00",
      "name": "Brian Lane",
      "firstname": "Brian",
      "lastname": "Lane",
      "username": "publicapitest",
      "email": "milos.tomic+pubapitest@shiftplanning.com",
      "group": "2",
      "status": "1",
      "birth_day": "0",
      "birth_month": "0",
      "avatar": {
        "small": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "medium": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png",
        "large": "https://d2xfcmp96gbhl7.cloudfront.net/app/layout/aff6056fde2fd33e33129177b510deab7cf1b3cd/images/no_avatar.png"
      },
      "ical": "https://www.humanity.shiftplanning.com/ical/869e0e6a380543a59443f360d49fa0fb.ics",
      "registered": "1469803042",
      "last_active": "1470140978",
      "p_phone": "1",
      "p_email": "1",
      "location": "0",
      "timezone": "314",
      "schedules": {
        "1321634": "Manager"
      },
      "skills": {
        "96398": "sales",
        "96403": "managing",
        "96404": "leadership"
      },
      "timezone_name": "Europe/Belgrade",
      "group_name": "Manager",
      "status_name": "Activated"
    }
  ],
  "token": "xxxxxxx"
}

Changes