latestOpenAPI 3.0.42026-08-10174362.4 KB

70fb92d278f5

User Settings

Get Users

Returns active users in the authenticated account. Uses the session's CompanyId and AccountId as security boundary.

search (optional): filters by UserName, FirstName, LastName, or Email (case-insensitive).

limit (optional): maximum results to return. Default: 50. Maximum allowed: 200.

Returns success=true with users=null when no users match the criteria.

get/users

Query parameters

searchstring
limitinteger

Response

Users retrieved.

successboolean

Indicates whether the user list was retrieved successfully.

errorstring nullable

Error description when Success is false. Null when the operation succeeds.