---
title: "getApplicationUsersByPage"
method: GET
path: "/applicationuser/v1/getApplicationUsersByPage"
tags: ["Application User Service"]
---

# getApplicationUsersByPage

`GET /applicationuser/v1/getApplicationUsersByPage`

Retrieve a list of Application Users across multiple pages.
Include additional details (e.g. User/Locations(s), User/Market(s), etc.) for a single Application User or all Application Users by using the `includeDetails` parameter.
Default page size is 10 Application Users, including their details if `includeDetails` is `true`.

## Query parameters

- `activeFlag` boolean
- `includeDetails` boolean
- `pageNumber` integer
- `pageSize` integer
- `userIdForDetails` string
- `includeNull` boolean
- `minutesSinceUpdate` integer

## Headers

- `authenticationtoken` string, required
- `password` string, required
- `sitename` string, required
- `userid` string, required
- `X-B3-TraceId` string

## Response `200`

Success

- ApplicationUserBatchResponseDto
  - `applicationUserDetails` ApplicationUserDetailsGet[]
    - `appUserBizIQDetails` AppUserBizIQDetailDto[]
      - `bizIqAccessLevel` string, required — "BizIQ User Access" level from the application user details.
      - `userId` string, required — "User ID" from the application user details.
    - `appUserConceptDetails` AppUserConceptDetailDto[]
      - `activeFlag` 'N' | 'Y', required — "Active" flag for the User/Concept record.
      - `conceptCode` string, required — "Concept Code" from the application user Concept details.
      - `userId` string, required — "User ID" from the application user details.
    - `appUserConsolidationVendorDetails` AppUserConsolidationVendorDetailDto[]
      - `activeFlag` 'N' | 'Y', required — "Active" flag for the User/Consolidation Vendor record.
      - `userId` string, required — "User ID" from the application user details.
      - `vendorCode` string, required — "Vendor Code" from the application user Consolidation Vendor details.
    - `appUserCustomerDetails` AppUserCustomerDetailDto[]
      - `activeFlag` 'N' | 'Y', required — "Active" flag for the User/Customer record.
      - `customer` string, required — "Customer Code" from the application user Customer details.
      - `locationCode` string, required — "Location Code" for the Location associated with the Customer, from the application user Customer details.
      - `userId` string, required — "User ID" from the application user details.
    - `appUserDailyAlertDetails` AppUserDailyAlertDetailDto[]
      - `activeFlag` 'N' | 'Y' — "Active" flag for the User/Daily Alert record.
      - `emailFormat` string, required — "E-mail Format" setting from the application user Daily Alert details. Must be ‘T’ (Text) or ‘I’ (Image).
      - `hierarchyType` string, required — "Hierarchy" Type from the application user Daily Alert details.
      - `locationCode` string, required — "Location" Code for the Hierarchy from the application user Daily Alert details.
      - `logicalName` string, required — Location "Logical Name" for the Hierarchy from the application user Daily Alert details.
      - `reportName` string, required — "Report" name from the application user Daily Alert details.
      - `userId` string, required — "User ID" from the application user details.
    - `appUserDepartmentDetails` AppUserDepartmentDetailDto[]
      - `activeFlag` string, required — "Active" flag for the User/Department record.
      - `approvalAuthority` string — "Approval Authority" flag from the application user Department details.
      - `approvalLimit` integer — "Approval Limit" from the application user Department details.
      - `locationCode` string, required — "Location Code" for the Location associated with the Department, from the application user Department details.
      - `locationDepartment` string, required — "location Department" name from the application user Department details.
      - `userId` string, required — "User ID" from the application user details.
    - `appUserDetails` AppUserDetailDto — AppUserDetailDto description
      - `activeFlag` 'N' | 'Y', required — "Active" flag from the application user 'User' tab.
      - `email` string, required — "E-mail" address from the application user 'User' tab.
      - `employeeNumber` string — "Employee Record" number from the application user 'User' tab.
      - `errors` CdpError[]
        - `errorMessage` string
        - `fieldNumber` integer
        - `lineNumber` integer
        - `parentFileLineNumber` integer
      - `ext` string — Telephone "Ext" from the application user 'User' tab.
      - `firstName` string, required — "First Name" from the application user 'User' tab.
      - `hhUserFlag` 'N' | 'Y' — "Hand-held User Flag" from the application user 'User' tab.
      - `hhUserId` string — "Hand-held User ID" from the application user 'User' tab.
      - `hhUserPassword` string — "Hand-held User Password" from the application user 'User' tab.
      - `language` string — "Language" from the application user 'User' tab.
      - `lastName` string, required — "Last Name" from the application user 'User' tab.
      - `newHireFlag` 'N' | 'Y', required — "New Hire" flag from the application user 'User' tab.
      - `teamworxFlag` 'N' | 'Y' — "Access Teamworx Mgr. Console" flag from the application user 'User' tab.
      - `telephone` string — "Telephone" from the application user 'User' tab.
      - `userGroup` string, required — "User Group" from the application user 'User' tab.
      - `userId` string, required — "User ID" from the application user 'User' tab.
    - `appUserFranchiseDetails` AppUserFranchiseDetailDto[]
      - `activeFlag` 'N' | 'Y', required — "Active" flag for the User/Franchise record.
      - `franchiseCode` string, required — "Franchise Code" from the application user Franchise details.
      - `userId` string, required — "User ID" from the application user details.
    - `appUserHierarchyDetails` AppUserHierarchyDetailDto[]
      - `activeFlag` 'N' | 'Y' — "Active" flag for the User/Hierarchy record.
      - `consolidatedDashboardFlag` 'N' | 'Y', required — "Consolidated Dashboard" flag from the application user Hierarchy details.
      - `hierarchyType` string, required — "hierarchy Type" from the application user Hierarchy details.
      - `limitExportLocationsFlag` 'N' | 'Y', required — "Limit Export Locations" flag from the application user Hierarchy details.
      - `locationCode` string, required — "Location" Code for the Hierarchy from the application user Hierarchy details.
      - `logicalName` string, required — Parent "Logical Name" for the Hierarchy from the application user Hierarchy details.
      - `userId` string, required — "User ID" from the application user details.
    - `appUserLocationDetails` AppUserLocationDetailDto[]
      - `activeFlag` 'N' | 'Y', required — "Active" flag for the User/Location record.
      - `locationCode` string, required — "Location" Code from the application user Location details.
      - `userId` string, required — "User ID" from the application user details.
    - `appUserMarketDetails` AppUserMarketDetailDto[]
      - `activeFlag` 'N' | 'Y', required — "Active" flag for the User/Market record.
      - `market` string, required — "Market" name from the application user Market details.
      - `userId` string, required — "User ID" from the application user details.
    - `appUserPasswordDetails` AppUserPasswordDetailDto[]
      - `password` string, required — Password for the Crunchtime Application User.
      - `userId` string, required — "User ID" from the application user details.
    - `userId` string — "User Id" from applicationUsers
  - `hasNext` boolean
  - `totalPages` integer

## Other responses

- `400` — Validation Error
- `401` — Authorization
- `429` — Too Many Requests
- `500` — Unexpected Error
- `503` — System under maintenance
- `504` — Timeout

---

[API](https://skmtc.net/crunchtime/apis/inventory-labor.md) · [All operations](https://skmtc.net/crunchtime/apis/inventory-labor/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crunchtime/inventory-labor/revisions/0af8e380ff2c/schema)