Get user

Endpoint

GET /api/users/{userId}

Example cURL request

curl --location 'https://<your-instance>.risk.com/api/users/3a2edf76-ca80-46cc-bddd-761ecbbdd658' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ••••••'

Example response (Internal user)

{
    "success": true,
    "result": {
        "entityId": "3a2edf76-ca80-46cc-bddd-761ecbbdd658",
        "createdAt": "2025-01-01T08:00:00.000Z",
        "modifiedAt": "2025-03-10T16:22:00.000Z",
        "coupaUserId": 12345,
        "coupaUsername": "jdoe",
        "email": "john.doe@example.com",
        "userName": "john.doe@example.com",
        "status": "General_Active",
        "ssoUsername": "janedoe_sso",
        "culture": "en-US",
        "prefix": "Mr",
        "title": "Accountant",
        "firstName": "John",
        "lastName": "Doe",
        "middleName": "Scott",
        "businessPhoneNumber": "1-800-555-1212x1234",
        "cellPhoneNumber": "1-888-555-9876",
        "address": {
            "street1": "123 Main St",
            "street2": "Apt 4B",
            "city": "Anytown",
            "state": "CA",
            "postalCode": "90210",
            "county": "Los Angeles",
            "country": "USA"
        },
        "userGroups": "Sales,Accounts",
        "userType": "Internal",
        "suppliers": null,
        "extensionFields": {
            "Department": "Finance",
            "CostCenter": "CC-101",
            "EmployeeID": "E-98765"
        },
        "links": [
            {
                "href": "api/users/3a2edf76-ca80-46cc-bddd-761ecbbdd658",
                "rel": "_self",
                "method": "GET"
            },
            {
                "href": "api/users",
                "rel": "retrieve-users",
                "method": "GET"
            }
        ]
    },
    "errors": []
}

Example response (Supplier user)

{
    "success": true,
    "result": {
        "entityId": "8ceb6513-52fa-487e-bda8-176e074a9372",
        "createdAt": "2024-06-01T12:00:00.000Z",
        "modifiedAt": "2025-01-05T09:00:00.000Z",
        "coupaUserId": null,
        "coupaUsername": null,
        "email": "ext.user@partner.com",
        "userName": "ext.user@partner.com",
        "status": "General_Active",
        "ssoUsername": "partner_sso",
        "culture": "en-US",
        "prefix": null,
        "title": null,
        "firstName": "Alex",
        "lastName": "Rivera",
        "middleName": null,
        "businessPhoneNumber": null,
        "cellPhoneNumber": null,
        "address": null,
        "userGroups": "Supplier Users",
        "userType": "Supplier",
        "suppliers": [
            {
                "entityId": "8ceb6513-52fa-487e-bda8-176e074a9371",
                "name": "Partner Corp",
                "externalReference": "EXT-SUP-001",
                "links": [
                    {
                        "href": "api/suppliers",
                        "rel": "retrieve-suppliers",
                        "method": "GET"
                    }
                ]
            }
        ],
        "extensionFields": {
            "Region": "EMEA"
        },
        "links": [
            {
                "href": "api/users/8ceb6513-52fa-487e-bda8-176e074a9372",
                "rel": "_self",
                "method": "GET"
            },
            {
                "href": "api/users",
                "rel": "retrieve-users",
                "method": "GET"
            }
        ]
    },
    "errors": []
}

Example error response

{
    "success": false,
    "result": null,
    "errors": [
        {
            "message": "User not found",
            "errorCode": "DataNotFound"
        }
    ]
}