# Retrieve all employees for a company Returns a paginated, summarized list of all employees registered under a specific company with Aslan. This endpoint provides essential employee information without sensitive or detailed fields. Supports filtering by status, role, and date ranges, plus sorting capabilities. Endpoint: GET /companies/{companyId}/users Version: 0.0.1 Security: partnerAdminAuth ## Header parameters: - `X-Aslan-Timestamp` (integer, required) Unix epoch timestamp of the request in seconds. Example: 1730000000 ## Path parameters: - `companyId` (string, required) The unique identifier for the company ## Query parameters: - `params` (object) ## Response 200 fields (application/json): - `content` (array, required) List of employee summaries in the current page - `content.id` (string, required) Unique system identifier for the employee Example: "f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d" - `content.status` (string, required) Current status of the employee with Aslan: * CREATED - Employee record created but invitation not yet sent * INVITED - Invitation to join Aslan has been sent to the employee * ACTIVE - Employee is actively enrolled and can access earned wage access benefits * DELETED - Employee record has been removed from the system * PAUSED - Employee's access to benefits is temporarily suspended * LEFT - Employee has left the company and is no longer eligible Enum: "CREATED", "INVITED", "ACTIVE", "DELETED", "PAUSED", "LEFT" - `content.firstName` (string, required) Employee's legal first name Example: "Sarah" - `content.lastName` (string, required) Employee's legal last name Example: "Johnson" - `content.email` (string, required) Primary work email address for the employee Example: "sarah.johnson@techflow.com" - `content.phoneNumber` (string) Contact phone number in international format Example: "+44 7123 456789" - `content.role` (string, required) Employee's role within the company and their permission level in Aslan: * EMPLOYEE - Standard employee with access to personal wage access features * MANAGER - Manager with additional reporting and team oversight capabilities * ADMIN - Company administrator with full company management capabilities * SUPER_ADMIN - Super administrator with extended system-level permissions Enum: "EMPLOYEE", "MANAGER", "ADMIN", "SUPER_ADMIN" - `content.companyId` (string, required) Unique identifier of the company this employee belongs to Example: "a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f" - `content.friendlyId` (string, required) Human-readable alphanumeric identifier for the employee (max 10 characters) Example: "F7E6D5C4B3" - `content.externalPayrollId` (string) Employee identifier from the external payroll system for reconciliation purposes Example: "PAY-2024-00847" - `content.startDate` (string) Employee's start date with the company Example: "2024-01-15" - `page` (integer, required) Current page number (zero-based) - `size` (integer, required) Number of items per page Example: 20 - `totalElements` (integer, required) Total number of employees across all pages Example: 543 - `totalPages` (integer, required) Total number of pages Example: 28 ## Response 400 fields (application/json): - `timestamp` (string, required) Timestamp when the error occurred Example: "2024-10-10T15:45:30Z" - `status` (integer, required) HTTP status code Example: 400 - `error` (string, required) HTTP status text Example: "Bad Request" - `message` (string, required) Human-readable error message describing what went wrong Example: "Invalid date range: fromDate must be before toDate" - `path` (string, required) API endpoint path where the error occurred Example: "/api/v1/companies/a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f/users/f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d/spend-report" - `errors` (array) Detailed validation errors (present for validation failures) - `errors.field` (string, required) Name of the field that failed validation Example: "email" - `errors.message` (string, required) Validation error message for this field Example: "Email address is already in use" - `errors.rejectedValue` (string) The value that was rejected (may be omitted for sensitive data) Example: "sarah.johnson@techflow.com" - `traceId` (string) Unique identifier for tracing this error in logs Example: "a1b2c3d4-e5f6-4a8b-9c0d-e1f2a3b4c5d6" ## Response 401 fields (application/json): - `timestamp` (string, required) Timestamp when the error occurred Example: "2024-10-10T15:45:30Z" - `status` (integer, required) HTTP status code Example: 400 - `error` (string, required) HTTP status text Example: "Bad Request" - `message` (string, required) Human-readable error message describing what went wrong Example: "Invalid date range: fromDate must be before toDate" - `path` (string, required) API endpoint path where the error occurred Example: "/api/v1/companies/a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f/users/f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d/spend-report" - `errors` (array) Detailed validation errors (present for validation failures) - `errors.field` (string, required) Name of the field that failed validation Example: "email" - `errors.message` (string, required) Validation error message for this field Example: "Email address is already in use" - `errors.rejectedValue` (string) The value that was rejected (may be omitted for sensitive data) Example: "sarah.johnson@techflow.com" - `traceId` (string) Unique identifier for tracing this error in logs Example: "a1b2c3d4-e5f6-4a8b-9c0d-e1f2a3b4c5d6" ## Response 403 fields (application/json): - `timestamp` (string, required) Timestamp when the error occurred Example: "2024-10-10T15:45:30Z" - `status` (integer, required) HTTP status code Example: 400 - `error` (string, required) HTTP status text Example: "Bad Request" - `message` (string, required) Human-readable error message describing what went wrong Example: "Invalid date range: fromDate must be before toDate" - `path` (string, required) API endpoint path where the error occurred Example: "/api/v1/companies/a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f/users/f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d/spend-report" - `errors` (array) Detailed validation errors (present for validation failures) - `errors.field` (string, required) Name of the field that failed validation Example: "email" - `errors.message` (string, required) Validation error message for this field Example: "Email address is already in use" - `errors.rejectedValue` (string) The value that was rejected (may be omitted for sensitive data) Example: "sarah.johnson@techflow.com" - `traceId` (string) Unique identifier for tracing this error in logs Example: "a1b2c3d4-e5f6-4a8b-9c0d-e1f2a3b4c5d6" ## Response 404 fields (application/json): - `timestamp` (string, required) Timestamp when the error occurred Example: "2024-10-10T15:45:30Z" - `status` (integer, required) HTTP status code Example: 400 - `error` (string, required) HTTP status text Example: "Bad Request" - `message` (string, required) Human-readable error message describing what went wrong Example: "Invalid date range: fromDate must be before toDate" - `path` (string, required) API endpoint path where the error occurred Example: "/api/v1/companies/a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f/users/f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d/spend-report" - `errors` (array) Detailed validation errors (present for validation failures) - `errors.field` (string, required) Name of the field that failed validation Example: "email" - `errors.message` (string, required) Validation error message for this field Example: "Email address is already in use" - `errors.rejectedValue` (string) The value that was rejected (may be omitted for sensitive data) Example: "sarah.johnson@techflow.com" - `traceId` (string) Unique identifier for tracing this error in logs Example: "a1b2c3d4-e5f6-4a8b-9c0d-e1f2a3b4c5d6" ## Response 500 fields (application/json): - `timestamp` (string, required) Timestamp when the error occurred Example: "2024-10-10T15:45:30Z" - `status` (integer, required) HTTP status code Example: 400 - `error` (string, required) HTTP status text Example: "Bad Request" - `message` (string, required) Human-readable error message describing what went wrong Example: "Invalid date range: fromDate must be before toDate" - `path` (string, required) API endpoint path where the error occurred Example: "/api/v1/companies/a3f2e1d0-5c4b-4a3e-9f8e-7d6c5b4a3e2f/users/f7e6d5c4-b3a2-4918-8e7d-6c5b4a3f2e1d/spend-report" - `errors` (array) Detailed validation errors (present for validation failures) - `errors.field` (string, required) Name of the field that failed validation Example: "email" - `errors.message` (string, required) Validation error message for this field Example: "Email address is already in use" - `errors.rejectedValue` (string) The value that was rejected (may be omitted for sensitive data) Example: "sarah.johnson@techflow.com" - `traceId` (string) Unique identifier for tracing this error in logs Example: "a1b2c3d4-e5f6-4a8b-9c0d-e1f2a3b4c5d6"