User Endpoint

This endpoint returns information about the users in the system.

https://api.workwelltech.com/users

By default, this will return an array of all users in the account.

Filter

A filter can be applied by specifying any of the following parameters in the body of the request:

Field	Type	Optional	Example
UserId	Integer	Yes	2160023
Name	String	Yes	Dan
PayrollNumber	String	Yes	5026

An example request body with a filter might look like the following:

{
  "Name": "Dan"
}

This would return all users with a name containing “Dan”
 

Response Object

The response object contains two properties, the Product, which will always return “uAttend” and the Body.
The body contains three properties, each of which are arrays as you can see below:

{
    "Product": "uAttend",
    "Body": {
        "Users": [
            {
                "UserId": "2160023",
                "FirstName": "Dan",
                "LastName": "Ford",
                "RoleId": 3,
                "AccountId": 8210,
                "DepartmentId": "46960",
                "IsActive": true,
                "Email": "",
                "PayrollNumber": "5026",
                "PhoneNumber": ""
            }
        ],
        "Response": {
            "$id": "1",
            "PkId": "0",
            "PkFieldName": null,
            "Success": true,
            "Keys": {},
            "Messages": {}
        },
        "ResponseList": []
    }
}

Data Types

The Users array contains the following properties:

Field	Type	Example
UserId	String	2160023
FirstName	String	Dan
LastName	String	Ford
RoleId	Integer	3
AccountId	Integer	8210
DepartmentId	String	46960
IsActive	Boolean	True
Email	String	[e-mail]
PayrollNumber	String	5026
PhoneNumber	String	01761 123456