| Requires any of the roles: | Admin, TenantAdmin, AccessAdmin, Receptionist |
| GET | /users/employees | Gets all employees at an organization. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | integer | No | Api version |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | IEnumerable<BusinessUserProfileDataView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| ActivationStatus | form | ActivationStatus | No | |
| UserName | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| form | string | No | ||
| TemporaryEmail | form | string | No | |
| EmailConfirmed | form | bool | No | |
| PhoneNumber | form | string | No | |
| TemporaryPhoneNumber | form | string | No | |
| PhoneNumberConfirmed | form | bool | No | |
| Roles | form | List<string> | No | |
| OrganizationId | form | Guid? | No | |
| BusinessOrganizations | form | HashSet<OrganizationBasicView> | No | |
| ViviotId | form | string | No | |
| ImageContent | form | string | No | |
| ImageUrl | form | string | No |
| Name | Value |
|---|---|
| Unconfirmed | 0 |
| Temporary | 10 |
| OwnershipConfirmed | 20 |
| IdentityConfirmed | 30 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | No | |
| Type | form | OrganizationType | No | |
| SubOrganizations | form | List<OrganizationBasicView> | No |
| Name | Value |
|---|---|
| Unknown | 0 |
| Admin | 10 |
| Tenant | 20 |
| Location | 30 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /users/employees HTTP/1.1 Host: api.4spaces.io Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}