Home Features Pricing
Case studies Blog Support Contact us
Call us today on +44 (0)1227 812932 Get your FREE Trial

Controller : User

VERSION: 4.0, DEPRECATED: NO

create retrieve get-by-id get-my-details update del get-approvers my-staff Return to API overview

Calls: {root}/user


POSTcreate

Route: {root}/v4/user/create
Request type User level Requires authentication Response type
BODY SUPER USER Yes Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
staff_code STRING OPTIONAL 0 20 - -
title STRING OPTIONAL 0 10 - -
first_name STRING REQUIRED 0 50 - -
middle_name STRING OPTIONAL 0 50 - -
last_name STRING REQUIRED 0 50 - -
user_type_id CUSTOM REQUIRED 100 310 - staff (100)
approver (200)
approver plus add (210)
approver plus add edit cancel (220)
super user (300)
super user with staff hub (310)
default_view_type_id CUSTOM REQUIRED 1 2 - department (1)
tag (2)
default_view_id [INT32] ✓ OPTIONAL 0 2147483647 - -
default_sorting_id CUSTOM ✓ OPTIONAL - no sort (0)
first name asc (1)
first name desc (2)
last name asc (3)
last name desc (4)
department_id [INT32] REQUIRED 0 2147483647 - -
approver_id [INT32] REQUIRED 0 2147483647 - -
notifier_2_id [INT32] REQUIRED 0 2147483647 - -
notifier_3_id [INT32] REQUIRED 0 2147483647 - -
email_contact STRING REQUIRED 5 255 - -
password STRING REQUIRED 0 50 - -
email_type_id CUSTOM REQUIRED 0 2 - none (0)
text (1)
html (2)
allowance_type_id CUSTOM REQUIRED 0 1 - days (0)
hours (1)
status_id CUSTOM ✓ OPTIONAL - disabled (0)
active (1)
employment_started_date DATE OPTIONAL - -
employment_ended_date DATE OPTIONAL - -
work_telephone STRING OPTIONAL 0 60 - -
mobile_telephone STRING OPTIONAL 0 30 - -
active_directory_username STRING OPTIONAL 0 50 - -
allowances NESTED OPTIONAL List (Of allowances) -

Nested object(s)[]

Object name Param name Type Is Nullable? Required? Min. Max.
allowances
start_dateDateFalseREQUIRED
openingminute(int32)FalseREQUIRED-21474836472147483647
remainingminute(int32)FalseREQUIRED-21474836472147483647
cURL
curl --location --request POST "{{ROOT}}user/create/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"staff_code": "sample","title": "sample","first_name": "sample","middle_name": "sample","last_name": "sample","user_type_id": "100","default_view_type_id": "1","default_view_id": "123456","default_sorting_id": "0","department_id": "123456","approver_id": "123456","notifier_2_id": "123456","notifier_3_id": "123456","email_contact": "sample","password": "sample","email_type_id": "0","allowance_type_id": "0","status_id": "0","work_telephone": "sample","mobile_telephone": "sample","active_directory_username": "sample","allowances": [{"start_date":,"opening":,"remaining":},{"start_date":,"opening":,"remaining":}]}'

Response object 
[
    {
      "object_name":"user_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"image_url_small",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"image_url_large",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"forceMFA",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]



POSTretrieve

Route: {root}/v4/user/retrieve
Request type User level Requires authentication Response type
BODY STAFF Yes Array()

Params

Name Type Nullable? Required? Min. Max. Nest Custom
map_type_id CUSTOM REQUIRED 0 5 - company (0)
department (1)
tag (2)
staff (3)
my staff (4)
by approver (5)
map_id [INT32] REQUIRED 0 2147483647 - -
last_name STRING OPTIONAL 0 250 - -
status_id CUSTOM REQUIRED 0 99 - disabled (0)
active (1)
both (99)
cURL
curl --location --request POST "{{ROOT}}user/retrieve/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"map_type_id": "0","map_id": "123456","last_name": "sample","status_id": "0"}'

Response object 
[
    {
      "object_name":"user_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"status_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"disabled",
                "value":"0"
            },
            {
                "name":"active",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"staff_code",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"title",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"email_contact",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"email_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"text",
                "value":"1"
            },
            {
                "name":"html",
                "value":"2"
            }]
      "note": 
  },
    {
      "object_name":"approver_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"department_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"department_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"user_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"approver plus add",
                "value":"210"
            },
            {
                "name":"approver plus add edit cancel",
                "value":"220"
            },
            {
                "name":"super user",
                "value":"300"
            },
            {
                "name":"super user with staff hub",
                "value":"310"
            }]
      "note": 
  },
    {
      "object_name":"notifier_2_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"notifier_3_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"allowance_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"days",
                "value":"0"
            },
            {
                "name":"hours",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"this_year_remaining",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"next_year_remaining",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]



GETget by id

Route: {root}/v4/user/get-by-id

Sample call: {root}/v4/user/get-by-id/12345678

Request type User level Requires authentication Response type
URL STAFF Yes Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
user_id INT32 REQUIRED 0 2147483647 - -
cURL
curl --location --request GET "{{ROOT}}user/get-by-id/12345678-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \

Response object 
[
    {
      "object_name":"user_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"status_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"disabled",
                "value":"0"
            },
            {
                "name":"active",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"staff_code",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"title",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"middle_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"user_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"approver plus add",
                "value":"210"
            },
            {
                "name":"approver plus add edit cancel",
                "value":"220"
            },
            {
                "name":"super user",
                "value":"300"
            },
            {
                "name":"super user with staff hub",
                "value":"310"
            }]
      "note": 
  },
    {
      "object_name":"default_view_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"department",
                "value":"1"
            },
            {
                "name":"tag",
                "value":"2"
            }]
      "note": 
  },
    {
      "object_name":"default_view_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"default_sorting_id",
      "type":"[Byte]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"department_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"email_contact",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"notifier_2_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"notifier_3_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"email_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"text",
                "value":"1"
            },
            {
                "name":"html",
                "value":"2"
            }]
      "note": 
  },
    {
      "object_name":"allowance_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"days",
                "value":"0"
            },
            {
                "name":"hours",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"active_directory_username",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"employment_started_date",
      "type":"Date",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"employment_ended_date",
      "type":"Date",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"work_telephone",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"mobile_telephone",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"last_logins",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"login_date",
                "type":"DateTime",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"device",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"image_url_small",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"image_url_large",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"google_unique_id",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"mfa_method_id",
      "type":"Int16",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]



GETget my details

Route: {root}/v4/user/get-my-details

Sample call: {root}/v4/user/get-my-details

Request type User level Requires authentication Response type
URL STAFF Yes Single

cURL
curl --location --request GET "{{ROOT}}user/get-my-details/-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \

Response object 
[
    {
      "object_name":"user_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"status_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"disabled",
                "value":"0"
            },
            {
                "name":"active",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"staff_code",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"title",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"middle_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"user_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"approver plus add",
                "value":"210"
            },
            {
                "name":"approver plus add edit cancel",
                "value":"220"
            },
            {
                "name":"super user",
                "value":"300"
            },
            {
                "name":"super user with staff hub",
                "value":"310"
            }]
      "note": 
  },
    {
      "object_name":"default_view_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"department",
                "value":"1"
            },
            {
                "name":"tag",
                "value":"2"
            }]
      "note": 
  },
    {
      "object_name":"default_view_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"default_sorting_id",
      "type":"[Byte]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"department_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"approver_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"email_contact",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"notifier_2_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"notifier_3_id",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"email_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"none",
                "value":"0"
            },
            {
                "name":"text",
                "value":"1"
            },
            {
                "name":"html",
                "value":"2"
            }]
      "note": 
  },
    {
      "object_name":"allowance_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"days",
                "value":"0"
            },
            {
                "name":"hours",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"active_directory_username",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"employment_started_date",
      "type":"Date",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"employment_ended_date",
      "type":"Date",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"work_telephone",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"mobile_telephone",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"last_logins",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"login_date",
                "type":"DateTime",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"device",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"image_url_small",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"image_url_large",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"google_unique_id",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"mfa_method_id",
      "type":"Int16",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]



PUTupdate

Route: {root}/v4/user/update
Request type User level Requires authentication Response type
BODY STAFF Yes Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
user_id INT32 REQUIRED 0 2147483647 - -
staff_code STRING OPTIONAL 0 20 - -
title STRING OPTIONAL 0 10 - -
first_name STRING OPTIONAL 0 50 - -
middle_name STRING OPTIONAL 0 50 - -
last_name STRING OPTIONAL 0 50 - -
user_type_id CUSTOM ✓ OPTIONAL - staff (100)
approver (200)
approver plus add (210)
approver plus add edit cancel (220)
super user (300)
super user with staff hub (310)
default_view_type_id CUSTOM ✓ OPTIONAL - department (1)
tag (2)
default_view_id [INT32] ✓ OPTIONAL 0 2147483647 - -
default_sorting_id CUSTOM ✓ OPTIONAL - no sort (0)
first name asc (1)
first name desc (2)
last name asc (3)
last name desc (4)
department_id [INT32] ✓ OPTIONAL 0 2147483647 - -
approver_id [INT32] ✓ OPTIONAL 0 2147483647 - -
notifier_2_id [INT32] ✓ OPTIONAL 0 2147483647 - -
notifier_3_id [INT32] ✓ OPTIONAL 0 2147483647 - -
email_contact STRING OPTIONAL 5 255 - -
password STRING OPTIONAL 0 50 - -
email_type_id CUSTOM ✓ OPTIONAL - none (0)
text (1)
html (2)
status_id CUSTOM ✓ OPTIONAL - disabled (0)
active (1)
employment_started_date DATE OPTIONAL - -
employment_ended_date DATE OPTIONAL - -
work_telephone STRING OPTIONAL 0 60 - -
mobile_telephone STRING OPTIONAL 0 30 - -
active_directory_username STRING OPTIONAL 0 50 - -
cURL
curl --location --request PUT "{{ROOT}}user/update/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"user_id": "123456","staff_code": "sample","title": "sample","first_name": "sample","middle_name": "sample","last_name": "sample","user_type_id": "100","default_view_type_id": "1","default_view_id": "123456","default_sorting_id": "0","department_id": "123456","approver_id": "123456","notifier_2_id": "123456","notifier_3_id": "123456","email_contact": "sample","password": "sample","email_type_id": "0","status_id": "0","work_telephone": "sample","mobile_telephone": "sample","active_directory_username": "sample"}'

Response object 
[
    {
      "object_name":"user_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"image_url_small",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"image_url_large",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"forceMFA",
      "type":"Boolean",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]



DELETEdel

Route: {root}/v4/user/del

Sample call: {root}/v4/user/del/12345678

Request type User level Requires authentication Response type
URL SUPER USER Yes Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
user_id INT32 REQUIRED 0 2147483647 - -
cURL
curl --location --request DELETE "{{ROOT}}user/del/12345678-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \


Standard response object returned, see API Overview for structure.



GETget approvers

Route: {root}/v4/user/get-approvers

Sample call: {root}/v4/user/get-approvers

Request type User level Requires authentication Response type
URL SUPER USER Yes Array()

cURL
curl --location --request GET "{{ROOT}}user/get-approvers/-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \

Response object 
[
    {
      "object_name":"user_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"user_type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"staff",
                "value":"100"
            },
            {
                "name":"approver",
                "value":"200"
            },
            {
                "name":"approver plus add",
                "value":"210"
            },
            {
                "name":"approver plus add edit cancel",
                "value":"220"
            },
            {
                "name":"super user",
                "value":"300"
            },
            {
                "name":"super user with staff hub",
                "value":"310"
            }]
      "note": 
  },
    {
      "object_name":"email_contact",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]



POSTmy staff

Route: {root}/v4/user/my-staff
Request type User level Requires authentication Response type
BODY APPROVER Yes Single

Params

Name Type Nullable? Required? Min. Max. Nest Custom
staff_filter CUSTOM REQUIRED 0 4 - all staff (0)
my staff (4)
start_date DATE REQUIRED - -
end_date DATE REQUIRED - -
cURL
curl --location --request POST "{{ROOT}}user/my-staff/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"staff_filter": "0"}'

Response object 
[
    {
      "object_name":"staff_overview",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"user_id",
                "type":"Int32",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"first_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"last_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"pending_request",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"allowance_type_id_this_year",
                "type":"[Byte]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"opening_this_year",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"remaining_this_year",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"carryover_opening_this_year",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"carryover_remaining_this_year",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"allowance_type_id_next_year",
                "type":"[Byte]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"opening_next_year",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"remaining_next_year",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"carryover_opening_next_year",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"carryover_remaining_next_year",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"overview",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"staff_total",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"staff_with_leave_total",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"absence_record_total",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_popular_leave_type_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_popular_leave_type_total",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_occurrences_first_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_occurrences_last_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_occurrences_total",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_accumulated_days_first_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_accumulated_days_last_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_accumulated_days_total",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_accumulated_hours_first_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_accumulated_hours_last_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_accumulated_hours_total",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"longest_absence_days_first_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"longest_absence_days_last_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"longest_absence_days_total",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"longest_absence_hours_first_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"longest_absence_hours_last_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"longest_absence_hours_total",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"leave_type_overview",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"code",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"colour",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"occurrences_total",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_occurrences_total",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_occurrences_first_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_occurrences_last_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_days_first_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_days_last_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_days_duration",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_hours_first_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_hours_last_name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"most_hours_duration",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"breakdown_by_leave_type",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"occurrences",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"name",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"colour",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  },
    {
      "object_name":"occurrences_by_duration",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"time_span",
                "type":"String",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"occurrences",
                "type":"[Int32]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            },
            {
                "object_name":"order_by",
                "type":"[Byte]",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  }
]

Don't have a WhosOff account yet?

Instantly reduce time spent on leave management with your FREE, no obligation trial today!
Sign up today and get until Friday, 25th April 2025 to try the full service, for Free!

Get your instant FREE account today
Close [X]
Get a personalised demo

Discover how WhosOff can elevate your leave management processes with a 20-min guided walkthrough.

Book your demonstration now

Cookie settings for whosoff.com

We use cookies to improve our website experience, we also use cookies to help us undertand how our website is used, enhance site navigation and analyze site usage and advertising. For more information please refer to our Cookie Policy.

AdvertisingEnables storage related to advertising, for example, advertising campaign.
AnalyticsEnables storage related to analytics, for example, visit duration.
TargetingSets consent for sending user data to Google for online advertising purposes.
MarketingSets consent for personalized advertising.
Manage cookies