> ## Documentation Index > Fetch the complete documentation index at: https://help.vori.com/llms.txt > Use this file to discover all available pages before exploring further. # List employees > Lists employees, newest first. ## OpenAPI ````yaml /api/openapi.json get /v1/employees openapi: 3.0.0 info: title: Vori API description: '' version: 1.0.0 contact: {} servers: - url: https://api.vori.com description: production security: [] tags: [] paths: /v1/employees: get: tags: - Employees summary: List employees description: Lists employees, newest first. operationId: listEmployees parameters: - name: active required: false in: query description: Whether the employee has not been deactivated. schema: type: boolean - name: ending_before required: false in: query description: Return records that precede the record with this ID, in list order. schema: type: string pattern: ^[0-9]+$ - name: limit required: false in: query description: Maximum number of records to return. schema: minimum: 1 maximum: 100 default: 20 type: integer - name: starting_after required: false in: query description: Return records that follow the record with this ID, in list order. schema: type: string pattern: ^[0-9]+$ responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/EmployeeList' '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/ConflictingListParametersError' - $ref: '#/components/schemas/InvalidListCursorError' '403': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/InsufficientPermissionsError' - $ref: '#/components/schemas/NoBannerAssociationError' security: - bearer: [] components: schemas: EmployeeList: type: object properties: data: type: array items: $ref: '#/components/schemas/Employee' has_more: type: boolean description: Whether more records follow this page. description: A page of employees. required: - data - has_more ConflictingListParametersError: type: object properties: error_code: type: string enum: - conflicting_list_parameters required: - error_code InvalidListCursorError: type: object properties: error_code: type: string enum: - invalid_list_cursor required: - error_code InsufficientPermissionsError: type: object properties: error_code: type: string enum: - insufficient_permissions error_details: $ref: '#/components/schemas/InsufficientPermissionsErrorDetails' required: - error_code - error_details NoBannerAssociationError: type: object properties: error_code: type: string enum: - no_banner_association required: - error_code Employee: type: object properties: id: type: string description: Unique identifier for the record. authentication_rule: nullable: true description: >- Effective rule that determines how the employee authenticates at the POS. allOf: - $ref: '#/components/schemas/AuthenticationRule' created_at: type: string description: When the record was created. format: date-time deactivated_at: type: string nullable: true description: >- When the employee was deactivated, or null when the employee is active. format: date-time email_address: type: string nullable: true description: Employee's email address, or null when none is configured. format: email maxLength: 254 first_name: type: string description: Employee's first name. last_name: type: string description: Employee's last name. roles: description: Roles assigned to the employee. type: array items: $ref: '#/components/schemas/EmployeeRole' updated_at: type: string description: When the record was last changed. format: date-time virtual: type: boolean description: >- Whether the employee exists only to attribute orders and cannot sign in at a terminal. description: >- A staff member at a store, to whom point-of-sale activity can be attributed. required: - id - authentication_rule - created_at - deactivated_at - email_address - first_name - last_name - roles - updated_at - virtual InsufficientPermissionsErrorDetails: type: object properties: action: allOf: - $ref: '#/components/schemas/Action' resource: allOf: - $ref: '#/components/schemas/Resource' required: - action - resource AuthenticationRule: type: object properties: methods: type: array description: The credentials the employee presents to sign in. Never empty. items: $ref: '#/components/schemas/AuthenticationMethod' operator: description: >- How the methods combine: `and` requires every one of them, `or` requires any one of them. allOf: - $ref: '#/components/schemas/AuthenticationRuleOperator' description: >- How an employee proves their identity at the point of sale. An active employee with no rule of their own authenticates with a PIN. required: - methods - operator EmployeeRole: type: object properties: id: type: string description: Unique identifier for the role that is held. name: description: Name of the role. allOf: - $ref: '#/components/schemas/RoleName' store_id: type: string nullable: true description: >- The store the role applies at, or null when it applies at every store in the banner. description: >- A role held by an employee, and the store it applies at. The same role can be held at more than one store. required: - id - name - store_id Action: type: string enum: - '*' - cancel - check_in - create - delete - read - record_events - refund - restart - update - void Resource: type: string enum: - '*' - accounting_integration - agent_chats - api_clients - asynchronous_tasks - banners - blackhawk_transactions - capabilities - coupons - custom_quick_actions - datacap_transactions - departments - discounts - ditto_auth_tokens - edge_agents - electronic_shelf_labels - employees - files - food_modifiers - gift_cards - gl_code_mappings - house_accounts - inventory - inventory_sessions - invoices - item_modifiers - label_dimension_sets - label_sheet_profiles - label_stock_products - lanes - loyalty_bonuses - loyalty_campaigns - loyalty_rewards - notification_templates - offers - order_guides - pos_banner_configurations - pos_orders - pos_tills - price_tags - product_ranges - products - promotions - purchase_orders - receiving - reporting - revision_sessions - revisions - roles - shopper_tags - shoppers - store_product_inventory_counts - store_product_lots - store_product_rules - store_product_tag_templates - store_snap_incentive_program_coupons - store_vendor_merge_requests - store_vendor_product_merge_requests - store_vendor_products - store_vendors - stores - tag_printings - tag_template_presets - tag_templates - tax_rates - users - variable_weights - vendor_merge_requests - vendor_product_merge_requests - vendors - wallet_payments - wic_products AuthenticationMethod: type: string enum: - barcode - pin AuthenticationRuleOperator: type: string enum: - and - or RoleName: type: string enum: - everyone - manager securitySchemes: bearer: type: http scheme: bearer ```` ## Related topics - [The employee object](/api/employees/object.md) - [Retrieve an employee](/api-reference/employees/retrieve-an-employee.md) - [List transactions](/api-reference/transactions/list-transactions.md)