> ## Documentation Index
> Fetch the complete documentation index at: https://docs.filexpress.app/llms.txt
> Use this file to discover all available pages before exploring further.

# List employees

> Employees of the business, paginated. Includes personal data and salary.

**Required permission:** `hr.employees`



## OpenAPI

````yaml /api-reference/openapi.en.json get /hr/employees
openapi: 3.0.3
info:
  title: FileXpress External API
  version: 1.0.0
  description: >-
    API for integrating third-party systems with FileXpress: billing, HR,
    accounting, inventory, projects, accounts receivable and payable, treasury,
    pricing and promotions, and cash. Current base URL: /api/external/v1. The
    legacy unversioned path (/api/external) will be removed on January 1, 2027;
    migrate to /api/external/v1 (same endpoints, only the base URL changes). The
    v2 API (/api/external/v2) exposes currencies and exchange rates, sales and
    purchases in foreign currency, taxes by id, payrolls with branch, and errors
    with a stable `code`; its operations carry the /v2 prefix in the path. We
    suggest migrating to the available v2 routes before March 30, 2027.
servers:
  - url: https://api.filexpress.app/api/external/v1
    description: Production
security:
  - ApiKey: []
tags:
  - name: General
  - name: Billing · Sales
  - name: Billing · Purchases
  - name: Billing · Customers
  - name: Billing · Suppliers
  - name: Billing · Products
  - name: Catalogs
  - name: HR · Employees
  - name: HR · Attendance
  - name: HR · Labor rules
  - name: HR · Schedules
  - name: HR · Holidays
  - name: HR · Attendance results
  - name: HR · Leave requests
  - name: HR · Payrolls
  - name: Accounting
  - name: Inventory
  - name: Projects
  - name: Accounts receivable
  - name: Accounts payable
  - name: Treasury
  - name: Pricing and promotions
  - name: Cash
  - name: Points of sale
  - name: API v2 · General
  - name: API v2 · Currencies and rates
  - name: API v2 · Countries
  - name: API v2 · Sales
  - name: API v2 · Purchases
  - name: API v2 · Payrolls
paths:
  /hr/employees:
    get:
      tags:
        - HR · Employees
      summary: List employees
      description: |-
        Employees of the business, paginated. Includes personal data and salary.

        **Required permission:** `hr.employees`
      parameters:
        - name: is_active
          in: query
          required: false
          description: 1 = active, 0 = inactive. Without the parameter, returns both.
          schema:
            type: boolean
        - name: search
          in: query
          required: false
          description: Searches by first name, last name, or email.
          schema:
            type: string
        - name: document_number
          in: query
          required: false
          description: Exact document number.
          schema:
            type: string
          example: 01234567-8
        - name: per_page
          in: query
          required: false
          description: Results per page (1–200, default 50).
          schema:
            type: integer
        - name: page
          in: query
          required: false
          description: Page.
          schema:
            type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                status: true
                data:
                  data:
                    - id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                      first_name: María
                      last_name: López
                      document_type: DUI
                      document_number: 01234567-8
                      tax_number: 0614-010190-101-1
                      email: maria@empresa.com
                      phone: 7000-0000
                      type: permanent
                      job_title: Contadora
                      hire_date: '2024-02-01'
                      salary: 850
                      employment_relationship: labor
                      pay_type: salaried
                      hourly_rate: null
                      is_active: true
                  pagination:
                    current_page: 1
                    last_page: 1
                    per_page: 50
                    total: 1
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '422':
          $ref: '#/components/responses/E422'
        '429':
          $ref: '#/components/responses/E429'
components:
  responses:
    E401:
      description: Missing or invalid API Key
      content:
        application/json:
          example:
            status: false
            message: Invalid API Key.
    E403:
      description: Integration without the required permission or deactivated
      content:
        application/json:
          example:
            status: false
            message: This integration does not have the 'hr.employees' permission.
            required_scope: hr.employees
    E422:
      description: Validation error
      content:
        application/json:
          example:
            status: false
            message: Validation errors
            errors:
              start_date:
                - The start date field is required.
    E429:
      description: Rate limit exceeded
      content:
        application/json:
          example:
            status: false
            message: Rate limit exceeded. Please try again later.
            rate_limit: 100
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Integration API Key (Integrations → New Integration).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.