Customer API - OpenAPI 3.0 (0.0.0)

Download OpenAPI specification:

OpenAPI 3.0 specification for the Customer API

Groups

Group operations

Get a list of all existing groups in the system

Authorizations:

BearerAuth

Responses

Response samples

200
401
500

Content type

application/json

{"data": [{"id": 1,
"groupType": 1,
"groupCategory": 1,
"groupAccess": 1,
"name": "Group",
"userGroupCategory": "System"
}
]
}

Reports

Management reporting data operations

Get a list of the management reporting data of each user of the given group

Authorizations:

BearerAuth

path Parameters

groupId

required

string

Example: 1

The group ID

query Parameters

limit required	integer Example: limit=100 The number of items in the response
offset required	integer Example: offset=0 The number of items to offset

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"groupReport": [{"id": 1,
"uniqueId": "userid",
"firstName": "John",
"lastName": "Doe",
"accountCreated": "2025-06-23T22:38:33.472Z",
"firstSync": "2025-06-23T22:38:33.472Z",
"lastSync": "2025-06-23T22:38:33.472Z",
"clientVersion": "string",
"dataDate": "2025-06-23T22:38:33.472Z",
"reportData": {"overallWellbeing": {"rating": "Good",
"score": 1
},
"computerUse": {"rating": "Good",
"score": 1
},
"breaks": {"rating": "Good",
"score": 1
},
"sitStand": {"rating": "Good",
"score": 1
}
}
}
]
},
"totalCount": 1
}

Ergonomics

Get a list of the office ergonomics reporting data of each user of the given group

Authorizations:

BearerAuth

path Parameters

groupId

required

string

Example: 1

The group ID

query Parameters

limit required	integer Example: limit=100 The number of items in the response
offset required	integer Example: offset=0 The number of items to offset

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"data": [{"userId": 1,
"uniqueId": "jdory",
"name": "John Dory",
"email": "jdory@example.com",
"assessments": [{"type": "Discomfort",
"enabled": true,
"scheduledDate": "1970-01-01T00:00:00.000Z",
"expiryDate": "2025-06-23T22:38:33.473Z",
"lastCompletedDate": "2025-06-23T22:38:33.473Z",
"overdue": false,
"expired": false,
"hasEverCompleted": true
}
],
"training": {"enabled": true,
"scheduledDate": "1970-01-01T00:00:00.000Z",
"lastCompletedDate": "2025-06-23T22:38:33.473Z",
"overdue": false,
"hasEverCompleted": true
}
}
]
}