Get Users Returns all users for a specific customer
Query Parameters The customer’s unique ID (from the List Customers endpoint)
Request Example curl -X GET "https://dashboard.sphud.com/api/external/users?customerId=cust-uuid-1234" \ -H "X-API-Key: sphud_abc12345_xxxxxxxxxxxxxxxxxxxxxxxx"
Response { "customerId" : "cust-uuid-1234" , "customerName" : "Acme Corp" , "users" : [ { "id" : "user-uuid-5678" , "name" : "Jane Doe" , "externalId" : "rmm-user-123" }, { "id" : "user-uuid-9012" , "name" : "John Smith" , "externalId" : "rmm-user-456" } ], "count" : 2 }
Import Users Import or sync users from an external system
Import users from Active Directory, RMM tools, or other systems. Users are matched by externalId first, then by name.
Request Body Array of user objects to import External identifier (e.g., from RMM or AD) - used for matching on future syncs
Import mode: merge or replace
merge (default): Adds new users, preserves existing onesreplace : Removes all existing users first, then imports Request Example curl -X POST "https://dashboard.sphud.com/api/external/users" \ -H "X-API-Key: sphud_abc12345_xxxxxxxxxxxxxxxxxxxxxxxx" \ -H "Content-Type: application/json" \ -d '{ "customerId": "cust-uuid-1234", "users": [ { "name": "Jane Doe", "externalId": "rmm-user-123" }, { "name": "John Smith", "externalId": "rmm-user-456" } ], "mode": "merge" }'
Response { "success" : true , "customerId" : "cust-uuid-1234" , "mode" : "merge" , "imported" : 2 , "total" : 15 }
Number of users added or updated in this import
Total number of users for this customer after import
Use merge mode for regular syncs to avoid deleting users. Use replace mode only when you need a complete refresh.
When using replace mode, all existing users will be removed before importing. Make sure your import data is complete!
