API 2.0
Users

Users

Query organization users

Retrieve list of company users
/users

Response

Sample response →
[
    {
        "id": "USER-ID",
        "companyRole": "User",
        "isAdmin": false,
        "momentCreated": "2018-01-08T15:35:16.648732",
        "name": "Alex Kim",
        "primaryEmail": "alex@company.com",
        "reportsToUserId": "USER-ID"
    },
    ...
]

Get organization user

Retrieve organization user details.
/user/USER-ID

Response

Sample response →
{
    "id": "USER-ID",
    "companyRole": "User",
    "isAdmin": false,
    "momentCreated": "2018-01-08T15:35:16.648732",
    "name": "Alex Kim",
    "primaryEmail": "alex@company.com",
    "reportsToUserId": "USER-ID"
}

Query Attendance Events

Retrieve a list of attendance events within a specific date range.
/attendance-events

Parameters

Name Required Type/Format Description
startDate yes YYYY-MM-DD Attendance events start date
endDate yes YYYY-MM-DD Attendance events end date
userId no "USER-ID" Attendance events user id

Response

Sample response →
[
    {
        "id": "ATTENDANCE-EVENT-ID",
        "linkedAttendanceEventId": "ATTENDANCE-EVENT-ID",
        "userId": "USER-ID",
        "createByUserId": "USER-ID"
        "officeId": "OFFICE-ID",
        "date": "2024-07-15",
        "momentCreated": "2024-07-16T11:54:52.093993",
        "timestamp": "2024-07-15T15:23:58.561027",
        "ipAddress": "127.0.0.1",
        "type": "CLOCK-OUT",
        "comment": "Some comment"
    },
    ...
]