GET Users

Retrieve a paginated list of users for the tenant.

Endpoint

Endpoint

/api/users

Method

GET

Scope

riskassess.user.read

Headers

Header Argument

Authorization

Bearer token

Accept

application/json or application/xml

X-Correlation-Id

(Optional) Request tracing ID

Parameters

Table 1. Query parameters
Parameter Description

limit

(Optional) Page size. Default: 50.

offset

(Optional) Number of rows to skip. Default: 0.

order_by

(Optional) Field name for sorting. Sortable fields: createdAt, modifiedAt.

dir

(Optional) Sort direction: Asc or Desc. Default: Asc.

entityId[eq]

(Optional) Filter by entity ID (exact match).

email[contains]

(Optional) Filter by email (partial match). Example: email[contains]=@acme.com

status[eq]

(Optional) Filter by user status. Example: status[eq]=General_Active

userType[eq]

(Optional) Filter by user type: Internal, Supplier, or Administrator.

Get users

Endpoint

GET /api/users

Example cURL request
curl --location 'https://<your-instance>.risk.com/api/users' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ••••••'
Example response
{
    "success": true,
    "result": {
        "totalCount": 2,
        "users": [
            {
                "entityId": "f5a2a07d-3e39-4aa4-83c9-35060d2faee9",
                "coupaUserId": 1001,
                "coupaUserName": "jdoe",
                "ssoUserName": "jdoe_sso",
                "userName": "john.doe@example.com",
                "firstName": "John",
                "lastName": "Doe",
                "email": "john.doe@example.com",
                "userType": "Internal",
                "suppliers": null,
                "status": "General_Active",
                "createdAt": "2025-01-15T10:30:00.000Z",
                "modifiedAt": "2025-02-01T14:00:00.000Z",
                "links": [
                    {
                        "href": "api/users",
                        "rel": "retrieve-users",
                        "method": "GET"
                    },
                    {
                        "href": "api/users/f5a2a07d-3e39-4aa4-83c9-35060d2faee9",
                        "rel": "_self",
                        "method": "GET"
                    }
                ]
            },
            {
                "entityId": "b18e46d0-8358-4014-8a8d-3a9fffe5ab3f",
                "coupaUserId": null,
                "coupaUserName": null,
                "ssoUserName": "supplier_contact",
                "userName": "contact@supplier.com",
                "firstName": "Jane",
                "lastName": "Smith",
                "email": "contact@supplier.com",
                "userType": "Supplier",
                "suppliers": [
                    {
                        "entityId": "66ff1a0d-bdf3-4a23-abf9-d4931458c58b",
                        "name": "Acme Supplies Ltd",
                        "links": [
                            {
                                "href": "api/suppliers",
                                "rel": "retrieve-suppliers",
                                "method": "GET"
                            }
                        ]
                    }
                ],
                "status": "General_Active",
                "createdAt": "2024-11-20T09:15:00.000Z",
                "modifiedAt": "2025-01-10T11:45:00.000Z",
                "links": [
                    {
                        "href": "api/users",
                        "rel": "retrieve-users",
                        "method": "GET"
                    },
                    {
                        "href": "api/users/b18e46d0-8358-4014-8a8d-3a9fffe5ab3f",
                        "rel": "_self",
                        "method": "GET"
                    }
                ]
            }
        ]
    },
    "errors": []
}