Workmax Concepts

Some familiarity with key concepts in Workmax can greatly increase your development speed and ensure your application can fully leverage the business capabilities we have exposed.

Workmax IDs

While many systems use an integer (e.g. 123) or GUID (e.g. 9738b8f9-58ea-412c-af5a-a07d75dc5769) to correspond to a particular record, Workmax uses dahsless guids as strings(9738b8f958ea412caf5aa07d75dc5769). You do not have to worry about generation as these are generated automatically by the server.

Paged Data

When using any of our list endpoints which return collections we utilize paging which returns the data in limited increments by page. So if I wanted to pull all 10,000 employees out of workmax I would have to make mulitple subsequent requests - this can be done programatically. Paging parameters are pageNumber and pageSize which are passed as query parameters in the url.

Example: Get Employees

curl --location --request GET \
'https://api.workmax.com/workmax/platform/v1/employees?pageNumber=1&pageSize=100' \
--header 'Authorization: Bearer {your-token}' \
--header 'Ocp-Apim-Subscription-Key: {your-subscription-key}' \

You should receive the response payload with a 200 status code:

{
    "data": [{
        "createdTimestamp": "string",
        "updatedTimestamp": "string",
        "status": 0,
        "externalId": "string",
        "updatedById": "string",
        "id": "string",
        "userId": "string",
        "email": "string",
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "emergencyContact": "string",
        "emergencyContactPhone": "string",
        "emergencyContactRelation": "string",
        "hireDate": "string",
        "lastRaiseAmount": 0,
        "lastRaiseDate": "string",
        "occupation": "string",
        "payGroupId": "string",
        "union": "string",
        "isAutoLunched": true,
        "birthDate": "string",
        "terminationDate": "string",
        "pin": "string",
        "defaultTimeZone": "string",
        "address": {
            "id": "string",
            "city": "string",
            "country": "string",
            "region": "string",
            "street": "string",
            "postalCode": "string"
        },
        "cellPhone": "string",
        "homePhone": "string",
        "workPhone": "string",
        "divisionId": "string",
        "departmentId": "string",
        "code": "string",
        "certifiedClass": "string",
        "unionClass": "string",
        "unionLocal": "string",
        "unionPayGroupId": "string",
        "requiresFaceCapture": true,
        "requiresRecognition": true,
        "language": "string",
        "isFormsTimeWorkflow": true,
        "requiresOutSignOff": true,
        "isAdministrator": true,
        "userRoleIds": ["string"],
        "wage": 0,
        "wcState": "string",
        "employeeGroupIds": ["string"],
        "permissionSetIds": ["string"],
        "permissionProfileIds": ["string"],
        "lastMobileLogIn": "string",
        "lastWebLogIn": "string",
        "customFieldValues": [{
            "id": "string",
            "name": "string",
            "value": "string"
        }],
        "wageType": {},
        "barcode": "string"
    }],
    "metadata": {
        "total": 1,
        "pageNumber": 1,
        "pageSize": 100
    }
}