This section give's control over the system's users.
Every user is stored in the DB with an attahcment to an account.
Every user can be related to a company (group) and some actions/settings will be applied to all the user's attached to the group.
Admin logged in - can upload users file,store new users in DB,attach user to companies,get information about all the users.
User logged in - can see it's own data about his user,account and company.
Retrieves a paginated list of users in the system along with key metadata for each user.
Users listed successfully
{- "totalItems": 319,
- "result": [
- {
- "id": "string",
- "external_uuid": "string",
- "username": "string",
- "email": "string",
- "status": "string",
- "user_type": "string",
- "ref_account_id": "string",
- "phone": "string",
- "login_counter": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
]
}Retrieves the full user details for a specific user by their unique ID.
User details retrieved successfully
{- "api_message": "USER_GET_SHOW_SUCCESS",
- "api_data": {
- "id": "string",
- "external_uuid": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "status": "string",
- "user_type": "string",
- "ref_account_id": "string",
- "login_counter": 0,
- "created_at": "2019-08-24T14:15:22Z"
}
}Creates a new user or admin account. Use the query parameter admin=true to create an admin user.
User created successfully
{- "username": "string",
- "email": "string",
- "phone": "string",
- "CID": "string"
}{- "api_message": "USER_POST_SUCCESS",
- "api_data": {
- "UUID": "string"
}
}