HomeGuidesAPI Reference
API Reference

GET Employees

get
https://www.humanity.com/api/v2/employees

/employees
Permission level: 7

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns array of all employees (activated, not activated). If you have specified schedule or location, it will return array of all employees related to specified schedule or location. Disabled employees can be retrieved with parameter "disabled":1, Not activated employees can be retrieved with "inactive":1

Query Params
int32

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

int32

Location ID

int32

enum [1] -> 1: Return disabled employees

int32

enum [1] -> 1: Return inactive employees

int32

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

int32

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

int32

enum [1]

string
enum

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

Responses

Updated 10 months ago

Did this page help you?
Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago

Did this page help you?