This resource allows for administrative tasks to be performed on users via the API.
Returns a paginated list of all users in the database.
[{"_id":"53bab4134d4d31c98d0a0000","admin":null,"agree_license":null,"approved":false,"company":"","company_url":"","disabled":false,"effective_date":null,"email":"email@email.com","first_name":"fname","last_name":"lname","npi":"","registry_id":"","registry_name":"","staff_role":true,"tin":"","username":"user"}]
| Param name | Description |
|---|---|
|
page optional |
Validations:
|
|
per_page optional |
Validations:
|
| Param name | Description |
|---|---|
|
id required |
The ID of the user to promote. Validations:
|
|
role required |
The role to promote the user to, for example staff_role or admin. Validations:
|
| Param name | Description |
|---|---|
|
id required |
The ID of the user to demote. Validations:
|
|
role required |
The role to demote the user from, for example staff_role or admin. Validations:
|
| Param name | Description |
|---|---|
|
id required |
The ID of the user to enable. Validations:
|
| Param name | Description |
|---|---|
|
id required |
The ID of the user to disable. Validations:
|
| Param name | Description |
|---|---|
|
id required |
The ID of the user to approve. Validations:
|
| Param name | Description |
|---|---|
|
id required |
The ID of the user to update. Validations:
|
|
npi required |
The new NPI to assign the user to. Validations:
|