API 2.0
Users

Users

Query organization users

Retrieve list of company users
/users

Parameters

Name Required Type/Format Description
deleted no true/false Select deleted company 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",
        "laborRate": 100,
        "serviceRate": 200,
        "phoneNumber": +1234567890,
        "skills": ["SKILL_ID",],
        "customFields":[
            {
                "decimalPlaces": 2,
                "fieldId": "cspx",
                "integersOnly": false,
                "label": "Currency",
                "positiveOnly": false,
                "symbolId": "euro",
                "type": "currency",
                "value": "43"
            },
        ]
    },
    ...
]

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",
    "laborRate": 100,
    "serviceRate": 200,
    "phoneNumber": +1234567890,
    "skills": ["SKILL_ID",],
    "customFields":[
        {
            "decimalPlaces": 2,
            "fieldId": "cspx",
            "integersOnly": false,
            "label": "Currency",
            "positiveOnly": false,
            "symbolId": "euro",
            "type": "currency",
            "value": "43"
        },
    ]
}

Query organization user hourly rate history

Retrieve the hourly rate history for a specific user within the organization.
/user/USER-ID/hourly-rate-history

Response

Sample response →
[
    {
        "id": "HOURLY_RATE_HISTORY_RECORD_ID",
        "laborRate": 100,
        "serviceRate": 200,
        "startMoment": "2025-10-15T00:00:00",
        "endMoment": "2025-10-20T00:00:00"
    },
    ...
]