API METHODS

MAPI71: SSH Key

MAPI71: User Group

SECTIONS

List Users

GET /api/admin/users

You can optionally pass ?include=balance to see their unprocessed usage. Unprocessed usage is the amount they have accrued that has not yet been sent to your invoice & payment system.

View User

GET /api/admin/users/{user_id}

In addition to querying a user by their user_id, you may also load a user by the following:

Attribute Query Param Example
email find_by_email /api/admin/users/{Base64.encode64('[email protected]')}?find_by_email=true
external_id find_by_external_id /api/admin/users/{some-external-id}?find_by_external_id=true
WHMCS Service ID find_by_label=whmcs_service_id /api/admin/users/{whmcs-service-id}?find_by_label=whmcs_service_id