API Reference
These docs are for v2.3. Click to read the latest docs for v3.0.

Gets all users

Sample Request:

GET /api/v2.3/misc/users

MAX PER PAGE LIMIT: 500

Sample Response:
{
    "data": [
        {
            "id": "3eb307ec-2a0d-4cfa-babd-08d9325f1801",
            "linkUserId": "3eb307ec-2a0d-4cfa-babd-08d9325f1801", - Same as id, provided for backwards compatibility
            "authUserId": "F2DB69D9-2118-4A2D-A027-C6363B3696DD",
            "fullName": "3eb307ec-2a0d-4cfa-babd-08d9325f1801",
            "email": "rubixx@rubixx.co.uk",
            "logLimit": 100.00,
            "varyLimit": 10.00,
            "varyPercentLimit": 50.00,
            "financialVaryLimit": 200.00,
            "financialVaryLimitPercent": 10.00,
            "isRefundApprover": false,
            "userType": 0,
            "isActive": true,
        }
    ],
    "page": 1,
    "total": 50,
    "limitPerPage": 1,
    "totalFilteredEntries": 50,
    "totalEntries": 50
}

User Types

0 = Normal User
1 = Customer Portal User
2 = Contractor Portal User

Log in to see full request history
Query Params
int32
Defaults to 25

The max number of items to return. Defaults to 25

int32
Defaults to 1

The current page number requested. Defaults to 1.

string

Optional filter to specify the user type. Defaults to null to include all user types

boolean
Defaults to false

Optional filter to include inactive users. Defaults to false

Response

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json