getAllApplicationUsers
Retrieve a list of Application Users, with limited information (e.g. Active status and User Group assignment). Retrieve this information about a single Application User, with additional details (e.g. User/Location(s), User/Market(s), etc.) by using the userIdForDetails and includeDetails fields.
Query parameters
Use true to limit retrieval to active Application Users. Use false to limit retrieval to inactive Application Users. Omit to retrieve all Application Users.
Use true to retrieve detailed information for a single Application User by using the user id as the userIdForDetails parameter value.
Provide the userId for a specific Application User to limit retrieval of that Application User's information. Add includeDetails = true for complete Application User information.
Specify 'true' to output null data elements.
The number of minutes since an application user record was last updated. Use to set how far back to search.
Headers
Secure token for API authentication.
Password for the Crunchtime Application User.
Crunchtime site identifier. (test or production)
User ID for the Crunchtime Application User
Optional trace identifier for troubleshooting.
Response
Success
Example response
[
{
"appUserBizIQDetails": [
{
"bizIqAccessLevel": "C"
}
],
"appUserConceptDetails": [
{
"activeFlag": "Y",
"conceptCode": "code"
}
],
"appUserConsolidationVendorDetails": [
{
"activeFlag": "Y",
"vendorCode": "vendorCode"
}
],
"appUserCustomerDetails": [
{
"activeFlag": "Y",
"customer": "customer",
"locationCode": "0000"
}
],
"appUserDailyAlertDetails": [
{
"activeFlag": "Y",
"emailFormat": "user@crunchtime.com",
"hierarchyType": "001",
"locationCode": "0000",
"logicalName": "crunchtime",
"reportName": "test"
}
],
"appUserDepartmentDetails": [
{
"activeFlag": "Y",
"approvalAuthority": "Authority",
"approvalLimit": 112334212,
"locationCode": "000000",
"locationDepartment": "crunchtime"
}
],
"appUserDetails": {
"activeFlag": "Y",
"email": "John@gmail.com",
"employeeNumber": "AUTO-0000000005",
"ext": "+12",
"firstName": "acf",
"hhUserFlag": "Y",
"hhUserPassword": "12@hi",
"language": "English",
"lastName": "john",
"newHireFlag": "N",
"teamworxFlag": "Y",
"telephone": "222-222-222",
"userGroup": "usersGroup"
},
"appUserFranchiseDetails": [
{
"activeFlag": "Y",
"franchiseCode": "C012"
}
],
"appUserHierarchyDetails": [
{
"activeFlag": "Y",
"consolidatedDashboardFlag": "N",
"hierarchyType": "customer",
"limitExportLocationsFlag": "N",
"locationCode": "000000",
"logicalName": "logicName"
}
],
"appUserLocationDetails": [
{
"activeFlag": "Y",
"locationCode": "000000"
}
],
"appUserMarketDetails": [
{
"activeFlag": "Y",
"market": "boston"
}
],
"appUserPasswordDetails": [
{
"password": "I@123"
}
]
}
]