| GET | /users | gets a list of BootView users |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsActive | query | int | No | 0 = Inactive, 1 = Active, 2 = All |
| IsInternal | query | int | No | 0 = External, 1 = Internal, 2 = All |
| UserNameContains | query | string | No | |
| FirstNameContains | query | string | No | |
| LastNameContains | query | string | No | |
| CityContains | query | string | No | |
| StateCode | query | string | No | |
| PhoneNumber | query | string | No | |
| LanguageCode | query | string | No | EN = English | SP = Spanish |
| CustomerId | query | Guid | No | |
| GroupId | query | Guid | No | |
| UserAliasContains | query | string | No | |
| MobileAppsAllowed | query | bool | No | |
| CanUseMIMS | query | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /users HTTP/1.1 Host: api.paylock.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
{
id: 00000000000000000000000000000000,
userName: String,
firstName: String,
lastName: String,
alias: String,
emailAddress: String,
city: String,
stateCode: String,
address1: String,
address2: String,
groupId: 00000000000000000000000000000000,
isActive: False,
isInternal: False,
languageCode: String,
mobilePhone: String,
phone: String,
timeZone: String,
zip: String,
status: 0,
homePageId: 0,
groupPermissions:
[
String
],
mobileAppsAllowed: False,
canUseMIMS: False,
apiTokenId: 00000000000000000000000000000000
}
]