---
updatedAt: 2026-06-12T14:08:37.000Z
agentTools:
  projectIndex: https://developer.crunchtime.com/llms.txt
---

# 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.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Swagger documentation supporting mobile development of Crunchtime.",
    "version": "2.99",
    "title": "Inventory & Labor",
    "termsOfService": "http://springfox.io",
    "contact": {
      "name": "Crunchtime Development Team",
      "url": "http://www.crunchtime.com",
      "email": "apiquestions@crunchtime.com"
    },
    "license": {
      "name": "Apache License Version 2.0",
      "url": "https://github.com/springfox/springfox/blob/master/LICENSE"
    }
  },
  "tags": [
    {
      "name": "Application User Service",
      "description": "The Application User service is used to create and retrieve user profiles where each user is assigned a unique User ID and password for logging in to Enterprise Manager, Net-Chef, or the Teamworx Manager Console.   It links users to specific locations, hierarchies, customers and markets, and assigns each user to a user group, which determines which screens and tasks the user will be able to access in the applications."
    }
  ],
  "paths": {
    "/applicationuser/v1/getAllApplicationUsers": {
      "get": {
        "tags": [
          "Application User Service"
        ],
        "summary": "getAllApplicationUsers",
        "description": "Retrieve a list of Application Users, with limited information (e.g. Active status and User Group assignment).\nRetrieve 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.",
        "operationId": "getAllApplicationUsersV1UsingGET",
        "parameters": [
          {
            "name": "activeFlag",
            "in": "query",
            "description": "Use `true` to limit retrieval to active Application Users.\nUse `false` to limit retrieval to inactive Application Users.\nOmit to retrieve all Application Users.",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "authenticationtoken",
            "in": "header",
            "description": "Secure token for API authentication.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "includeDetails",
            "in": "query",
            "description": "Use `true` to retrieve detailed information for a single Application User by using the user id as the `userIdForDetails` parameter value.",
            "required": false,
            "example": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "password",
            "in": "header",
            "description": "Password for the Crunchtime Application User.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sitename",
            "in": "header",
            "description": "Crunchtime site identifier. (test or production)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "userid",
            "in": "header",
            "description": "User ID for the Crunchtime Application User",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "userIdForDetails",
            "in": "query",
            "description": "Provide the `userId` for a specific Application User to limit retrieval of that Application User's information.\nAdd `includeDetails = true` for complete Application User information.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-B3-TraceId",
            "in": "header",
            "description": "Optional trace identifier for troubleshooting.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "includeNull",
            "in": "query",
            "description": "Specify 'true' to output null data elements.",
            "required": false,
            "allowEmptyValue": true,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "minutesSinceUpdate",
            "in": "query",
            "description": "The number of minutes since an application user record was last updated. Use to set how far back to search.",
            "required": false,
            "example": 1440,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "*/*": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ApplicationUserDetailsGet"
                  }
                }
              },
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ApplicationUserDetailsGet"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Validation Error",
            "content": {
              "*/*": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ObjectError"
                  }
                }
              },
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ObjectError"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Authorization",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected Error",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "504": {
            "description": "Timeout",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "externalDocs": {
    "description": "Crunchtime Developer Hub",
    "url": "https://developer.crunchtime.com/"
  },
  "servers": [
    {
      "url": "//webservices-test.net-chef.com"
    }
  ],
  "components": {
    "schemas": {
      "AppUserBizIQDetailDto": {
        "type": "object",
        "required": [
          "bizIqAccessLevel",
          "userId"
        ],
        "properties": {
          "bizIqAccessLevel": {
            "type": "string",
            "example": "C",
            "description": "\"BizIQ User Access\" level from the application user details."
          },
          "userId": {
            "type": "string",
            "example": 1,
            "description": "\"User ID\" from the application user details."
          }
        },
        "title": "AppUserBizIQDetailDto",
        "description": "AppUserBizIQDetailDto description"
      },
      "AppUserConceptDetailDto": {
        "type": "object",
        "required": [
          "activeFlag",
          "conceptCode",
          "userId"
        ],
        "properties": {
          "activeFlag": {
            "type": "string",
            "example": "Y",
            "description": "\"Active\" flag for the User/Concept record.",
            "enum": [
              "N",
              "Y"
            ]
          },
          "conceptCode": {
            "type": "string",
            "example": "code",
            "description": "\"Concept Code\" from the application user Concept details."
          },
          "userId": {
            "type": "string",
            "example": 1,
            "description": "\"User ID\" from the application user details."
          }
        },
        "title": "AppUserConceptDetailDto",
        "description": "AppUserConceptDetailDto description"
      },
      "AppUserConsolidationVendorDetailDto": {
        "type": "object",
        "required": [
          "activeFlag",
          "userId",
          "vendorCode"
        ],
        "properties": {
          "activeFlag": {
            "type": "string",
            "example": "Y",
            "description": "\"Active\" flag for the User/Consolidation Vendor record.",
            "enum": [
              "N",
              "Y"
            ]
          },
          "userId": {
            "type": "string",
            "example": 1,
            "description": "\"User ID\" from the application user details."
          },
          "vendorCode": {
            "type": "string",
            "example": "vendorCode",
            "description": "\"Vendor Code\" from the application user Consolidation Vendor details."
          }
        },
        "title": "AppUserConsolidationVendorDetailDto",
        "description": "AppUserConsolidationVendorDetailDto description"
      },
      "AppUserCustomerDetailDto": {
        "type": "object",
        "required": [
          "activeFlag",
          "customer",
          "locationCode",
          "userId"
        ],
        "properties": {
          "activeFlag": {
            "type": "string",
            "example": "Y",
            "description": "\"Active\" flag for the User/Customer record.",
            "enum": [
              "N",
              "Y"
            ]
          },
          "customer": {
            "type": "string",
            "example": "customer",
            "description": "\"Customer Code\" from the application user Customer details."
          },
          "locationCode": {
            "type": "string",
            "example": "0000",
            "description": "\"Location Code\" for the Location associated with the Customer, from the application user Customer details."
          },
          "userId": {
            "type": "string",
            "example": 1,
            "description": "\"User ID\" from the application user details."
          }
        },
        "title": "AppUserCustomerDetailDto",
        "description": "AppUserCustomerDetailDto description"
      },
      "AppUserDailyAlertDetailDto": {
        "type": "object",
        "required": [
          "emailFormat",
          "hierarchyType",
          "locationCode",
          "logicalName",
          "reportName",
          "userId"
        ],
        "properties": {
          "activeFlag": {
            "type": "string",
            "example": "Y",
            "description": "\"Active\" flag for the User/Daily Alert record.",
            "enum": [
              "N",
              "Y"
            ]
          },
          "emailFormat": {
            "type": "string",
            "example": "user@crunchtime.com",
            "description": "\"E-mail Format\" setting from the application user Daily Alert details. Must be ‘T’ (Text) or ‘I’ (Image)."
          },
          "hierarchyType": {
            "type": "string",
            "example": "001",
            "description": "\"Hierarchy\" Type from the application user Daily Alert details."
          },
          "locationCode": {
            "type": "string",
            "example": "0000",
            "description": "\"Location\" Code for the Hierarchy from the application user Daily Alert details."
          },
          "logicalName": {
            "type": "string",
            "example": "crunchtime",
            "description": "Location \"Logical Name\" for the Hierarchy from the application user Daily Alert details."
          },
          "reportName": {
            "type": "string",
            "example": "test",
            "description": "\"Report\" name from the application user Daily Alert details."
          },
          "userId": {
            "type": "string",
            "example": 1,
            "description": "\"User ID\" from the application user details."
          }
        },
        "title": "AppUserDailyAlertDetailDto",
        "description": "AppUserDailyAlertDetailDto description"
      },
      "AppUserDepartmentDetailDto": {
        "type": "object",
        "required": [
          "activeFlag",
          "locationCode",
          "locationDepartment",
          "userId"
        ],
        "properties": {
          "activeFlag": {
            "type": "string",
            "example": "Y",
            "description": "\"Active\" flag for the User/Department record."
          },
          "approvalAuthority": {
            "type": "string",
            "example": "Authority",
            "description": "\"Approval Authority\" flag from the application user Department details."
          },
          "approvalLimit": {
            "type": "integer",
            "format": "int64",
            "example": 112334212,
            "description": "\"Approval Limit\" from the application user Department details."
          },
          "locationCode": {
            "type": "string",
            "example": "000000",
            "description": "\"Location Code\" for the Location associated with the Department, from the application user Department details."
          },
          "locationDepartment": {
            "type": "string",
            "example": "crunchtime",
            "description": "\"location Department\" name from the application user Department details."
          },
          "userId": {
            "type": "string",
            "example": 1233,
            "description": "\"User ID\" from the application user details."
          }
        },
        "title": "AppUserDepartmentDetailDto",
        "description": "AppUserDepartmentDetailDto description"
      },
      "AppUserDetailDto": {
        "type": "object",
        "required": [
          "activeFlag",
          "email",
          "firstName",
          "lastName",
          "newHireFlag",
          "userGroup",
          "userId"
        ],
        "properties": {
          "activeFlag": {
            "type": "string",
            "example": "Y",
            "description": "\"Active\" flag from the application user 'User' tab.",
            "enum": [
              "N",
              "Y"
            ]
          },
          "email": {
            "type": "string",
            "example": "John@gmail.com",
            "description": "\"E-mail\" address from the application user 'User' tab."
          },
          "employeeNumber": {
            "type": "string",
            "example": "AUTO-0000000005",
            "description": "\"Employee Record\" number from the application user 'User' tab."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CdpError"
            }
          },
          "ext": {
            "type": "string",
            "example": "+12",
            "description": "Telephone \"Ext\" from the application user 'User' tab."
          },
          "firstName": {
            "type": "string",
            "example": "acf",
            "description": "\"First Name\" from the application user 'User' tab."
          },
          "hhUserFlag": {
            "type": "string",
            "example": "Y",
            "description": "\"Hand-held User Flag\" from the application user 'User' tab.",
            "enum": [
              "N",
              "Y"
            ]
          },
          "hhUserId": {
            "type": "string",
            "example": 12321,
            "description": "\"Hand-held User ID\" from the application user 'User' tab."
          },
          "hhUserPassword": {
            "type": "string",
            "example": "12@hi",
            "description": "\"Hand-held User Password\" from the application user 'User' tab."
          },
          "language": {
            "type": "string",
            "example": "English",
            "description": "\"Language\" from the application user 'User' tab."
          },
          "lastName": {
            "type": "string",
            "example": "john",
            "description": "\"Last Name\" from the application user 'User' tab."
          },
          "newHireFlag": {
            "type": "string",
            "example": "N",
            "description": "\"New Hire\" flag from the application user 'User' tab.",
            "enum": [
              "N",
              "Y"
            ]
          },
          "teamworxFlag": {
            "type": "string",
            "example": "Y",
            "description": "\"Access Teamworx Mgr. Console\" flag from the application user 'User' tab.",
            "enum": [
              "N",
              "Y"
            ]
          },
          "telephone": {
            "type": "string",
            "example": "222-222-222",
            "description": "\"Telephone\" from the application user 'User' tab."
          },
          "userGroup": {
            "type": "string",
            "example": "usersGroup",
            "description": "\"User Group\" from the application user 'User' tab."
          },
          "userId": {
            "type": "string",
            "example": 1,
            "description": "\"User ID\" from the application user 'User' tab."
          }
        },
        "title": "AppUserDetailDto",
        "description": "AppUserDetailDto description"
      },
      "AppUserFranchiseDetailDto": {
        "type": "object",
        "required": [
          "activeFlag",
          "franchiseCode",
          "userId"
        ],
        "properties": {
          "activeFlag": {
            "type": "string",
            "example": "Y",
            "description": "\"Active\" flag for the User/Franchise record.",
            "enum": [
              "N",
              "Y"
            ]
          },
          "franchiseCode": {
            "type": "string",
            "example": "C012",
            "description": "\"Franchise Code\" from the application user Franchise details."
          },
          "userId": {
            "type": "string",
            "example": 1,
            "description": "\"User ID\" from the application user details."
          }
        },
        "title": "AppUserFranchiseDetailDto",
        "description": "AppUserFranchiseDetailDto description"
      },
      "AppUserHierarchyDetailDto": {
        "type": "object",
        "required": [
          "consolidatedDashboardFlag",
          "hierarchyType",
          "limitExportLocationsFlag",
          "locationCode",
          "logicalName",
          "userId"
        ],
        "properties": {
          "activeFlag": {
            "type": "string",
            "example": "Y",
            "description": "\"Active\" flag for the User/Hierarchy record.",
            "enum": [
              "N",
              "Y"
            ]
          },
          "consolidatedDashboardFlag": {
            "type": "string",
            "example": "N",
            "description": "\"Consolidated Dashboard\" flag from the application user Hierarchy details.",
            "enum": [
              "N",
              "Y"
            ]
          },
          "hierarchyType": {
            "type": "string",
            "example": "customer",
            "description": "\"hierarchy Type\" from the application user Hierarchy details."
          },
          "limitExportLocationsFlag": {
            "type": "string",
            "example": "N",
            "description": "\"Limit Export Locations\" flag from the application user Hierarchy details.",
            "enum": [
              "N",
              "Y"
            ]
          },
          "locationCode": {
            "type": "string",
            "example": "000000",
            "description": "\"Location\" Code for the Hierarchy from the application user Hierarchy details."
          },
          "logicalName": {
            "type": "string",
            "example": "logicName",
            "description": "Parent \"Logical Name\" for the Hierarchy from the application user Hierarchy details."
          },
          "userId": {
            "type": "string",
            "example": 1,
            "description": "\"User ID\" from the application user details."
          }
        },
        "title": "AppUserHierarchyDetailDto",
        "description": "AppUserHierarchyDetailDto description"
      },
      "AppUserLocationDetailDto": {
        "type": "object",
        "required": [
          "activeFlag",
          "locationCode",
          "userId"
        ],
        "properties": {
          "activeFlag": {
            "type": "string",
            "example": "Y",
            "description": "\"Active\" flag for the User/Location record.",
            "enum": [
              "N",
              "Y"
            ]
          },
          "locationCode": {
            "type": "string",
            "example": "000000",
            "description": "\"Location\" Code from the application user Location details."
          },
          "userId": {
            "type": "string",
            "example": 1,
            "description": "\"User ID\" from the application user details."
          }
        },
        "title": "AppUserLocationDetailDto",
        "description": "AppUserLocationDetailDto description"
      },
      "AppUserMarketDetailDto": {
        "type": "object",
        "required": [
          "activeFlag",
          "market",
          "userId"
        ],
        "properties": {
          "activeFlag": {
            "type": "string",
            "example": "Y",
            "description": "\"Active\" flag for the User/Market record.",
            "enum": [
              "N",
              "Y"
            ]
          },
          "market": {
            "type": "string",
            "example": "boston",
            "description": "\"Market\" name from the application user Market details."
          },
          "userId": {
            "type": "string",
            "example": 1,
            "description": "\"User ID\" from the application user details."
          }
        },
        "title": "AppUserMarketDetailDto",
        "description": "AppUserMarketDetailDto description"
      },
      "AppUserPasswordDetailDto": {
        "type": "object",
        "required": [
          "password",
          "userId"
        ],
        "properties": {
          "password": {
            "type": "string",
            "example": "I@123",
            "description": "Password for the Crunchtime Application User."
          },
          "userId": {
            "type": "string",
            "example": 1233,
            "description": "\"User ID\" from the application user details."
          }
        },
        "title": "AppUserPasswordDetailDto",
        "description": "AppUserPasswordDetailDto description"
      },
      "ApplicationUserDetailsGet": {
        "type": "object",
        "properties": {
          "appUserBizIQDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppUserBizIQDetailDto"
            }
          },
          "appUserConceptDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppUserConceptDetailDto"
            }
          },
          "appUserConsolidationVendorDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppUserConsolidationVendorDetailDto"
            }
          },
          "appUserCustomerDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppUserCustomerDetailDto"
            }
          },
          "appUserDailyAlertDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppUserDailyAlertDetailDto"
            }
          },
          "appUserDepartmentDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppUserDepartmentDetailDto"
            }
          },
          "appUserDetails": {
            "$ref": "#/components/schemas/AppUserDetailDto"
          },
          "appUserFranchiseDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppUserFranchiseDetailDto"
            }
          },
          "appUserHierarchyDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppUserHierarchyDetailDto"
            }
          },
          "appUserLocationDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppUserLocationDetailDto"
            }
          },
          "appUserMarketDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppUserMarketDetailDto"
            }
          },
          "appUserPasswordDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppUserPasswordDetailDto"
            }
          },
          "userId": {
            "type": "string",
            "example": 1233,
            "description": "\"User Id\" from applicationUsers"
          }
        },
        "title": "ApplicationUserDetailsGet",
        "description": "ApplicationUserDetailsGet description"
      },
      "CdpError": {
        "type": "object",
        "properties": {
          "errorMessage": {
            "type": "string"
          },
          "fieldNumber": {
            "type": "integer",
            "format": "int32"
          },
          "lineNumber": {
            "type": "integer",
            "format": "int32"
          },
          "parentFileLineNumber": {
            "type": "integer",
            "format": "int32"
          }
        },
        "title": "CdpError"
      },
      "ObjectError": {
        "type": "object",
        "properties": {
          "arguments": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "code": {
            "type": "string"
          },
          "codes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "defaultMessage": {
            "type": "string"
          },
          "objectName": {
            "type": "string"
          }
        },
        "title": "ObjectError"
      }
    }
  }
}
```