1. Home
  2. Docs
  3. Employee Sync
  4. Read Employee Data
  5. Understanding the /users Response

Understanding the /users Response

Now that you know how to make a basic request to read user data and how to use certain filters with it, let’s explore the response. We’ll use this example response to understand what fields are important:

Example Response

{
    "status": "success",
    "total": 3,
    "offset": 0,
    "limit": 50,
    "data": [
        {
            "user": {
                "id": 2351418,
                "firstname": "Bertram",
                "lastname": "Gilfoyle",
                "user_type_id": 1,
                "email": "bertram.gilfoyle@piedpiper.com",
                "mobile_phone": "(555) 555-5555",
                "home_phone": "(777) 777-7777",
                "payroll_id": 83745270,
                "employee_id": 2329,
                "active": false,
                ...
            }
        },
        {
            "user": {
                "id": 2645543,
                "firstname": "Dinesh",
                "lastname": "Chugtai",
                "user_type_id": 1,
                "email": "dinesh.chugtai@piedpiper.com",
                "payroll_id": 98643832,
                "employee_id": 5057,
                "active": false,
                ...
            }
        },
        {
            "user": {
                "id": 2789647,
                ...
            }
        },
    ]
}

Within the response, every object in the data array represents one user.

You’ll mostly be working with only a few fields in each user object in the response. Here are some details on them:

user FieldTypeExplanation
idNumeric IndexID that is essentially the index ID of the user in 7shifts
firstnameStringFirst name of the user
lastnameStringLast name of the user
user_type_idNumericValue specifies type of the user in 7shifts:
1 – Employee, 2 – Administrator, 3 – Manager, 4 – Assistant Manager
emailStringEmail address of the user
mobile_phoneStringMobile phone number of the user
home_phoneStringHome phone number of the user
payroll_idNumericPayroll ID of the user, specified as “Employee ID” field in the 7shifts UI
employee_idNumericPunch ID of the user, not to be confused with the above field
activeBooleanSpecifies whether the user is currently active in 7shifts or not

A few things to note:

  • Please do not read the hourly_wage or wage_type fields on the user object. These fields will not always display the current wage values, and it is strongly recommended that you implement the requests specified in the next sections for getting current wage data.
  • payroll_id & employee_id fields can be confusing, given that they have different names in the UI.
    To clarify, employee_id is represented in the UI as ‘Punch ID’, and this is the ID that users use for time clocking through the 7punches app.
    payroll_id is represented in the UI as ‘Employee ID’, and this is the Payroll ID for their payroll provider, which is often used for payroll integrations.