Users Service

Swagger documentation: https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=User%20Service%20v1#

Retrieving a List of Users

If you need to retrieve a complete list of users for your tenant, you can use the endpoint

GET https://arc-aegis.billtrust.com/user/v1/tenants/{tenantId}/users

Example:

curl -X GET 'https://arc-aegis.billtrust.com/user/v1/tenants/{tenantId}/users' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>'

If successful, it will return a response body like the following:

[
    {
        "userId": "(user id)",
        "firstName": "John",
        "lastName": "Doe",
        "defaultLanguage": "en",
        "status": "Active",
        "role": "ADMIN",
        "tenantIds": [
            "{tenantId}"
        ],
        "groupIds": [
            "(removed)"
        ],
        "lastLogin": "2020-01-16T17:19:59.588Z",
        "lastAccessTokenSource": "USERNAME_PASSWORD",
        "createdDate": "2018-07-02T12:58:26.894Z",
        "email": "fake@email.com",
        "timeZone": "America/New_York",
        "timeZoneDateFormat": "DD MMM YYYY",
        "timeZoneTimeFormat": "hh:mma z",
        "timeZoneDateTimeDelimiter": " ",
        "defaultTenantId": null,
        "userTenantProfile": {
            "division": "Collections",
            "department": "Accounts Receivable",
            "title": "Collector",
            "region": "",
            "mobilePhone": "",
            "faxNumber": "",
            "address": "123 Main St.",
            "officePhone": "",
            "lastLogin": "...",
            "lastLoginMethod": "..."
        },
        "aliasUserIds": [
            "(user id)"
        ]
    }
]