Generic Resource
PEPPERI NOTIFICATION SERVICE
Actions Queue
CPI Node
TODO training

Get list of users

get
Get Users

https://api.pepperi.com/v1.0/users
Request
Response
Request
Headers
Authentication
required
string
Access Token from the IdP
Query Parameters
fields
optional
string
specify desired fields to return
include_deleted
optional
boolean
include hidden users in the result (false by default)
where
optional
string
an SQL like query (see below for supported fields)
order_by
optional
string
sort the rows in the result set.
page
optional
number
The desired page number
page_size
optional
number
The desired page size
include_count
optional
boolean
Add to the response header the number of returned objects
Response
200: OK
[
{
"InternalID": 242959,
"UUID": "dc73e0e0-fb66-43b5-85c8-c815a5c4bff3",
"ExternalID": "",
"CreationDateTime": "2018-03-11T11:57:07Z",
"Email": "[email protected]",
"FirstName": "qaQA",
"Hidden": false,
"IsSupportAdminUser": true,
"IsUnderMyRole": false,
"EmployeeType": 2,
"IsInTradeShowMode": false,
"Name": "qaQA qaQA",
"LastName": "qaQA",
"Mobile": "",
"ModificationDateTime": "2018-07-16T13:37:45Z",
"Phone": "",
"Profile": {
"Data": {
"InternalID": 48176,
"Name": "Rep"
},
"URI": "/profiles/48176"
},
"Role": {
"Data": {
"InternalID": 4091,
"Name": "Matrix Qa"
},
"URI": "/roles/4091"
},
"SecurityGroup": {
"UUID": "fcbc8ee0-2b42-4fa6-8666-389fdf6892ca",
"Name": "default group"
}
}
]
404: Not Found
{ "message": "our standart error"}

Note: There following API Names will return only if specified in the fields or where query parameters

ApiName

Name

EmployeeType

IsSupportAdminUser

IsUnderMyRole

SecurityGroupUUID - can be used only in the "fields"

SecurityGroupName - can be used only in the "fields"