Retrieve a paginated list of employees

GET

/v1/employees

Retrieves a paginated list of employees. Supports filtering by active status and sorting.

Required scope: employees:read

Request

Query Params

Responses

🟢200

application/json

Employees retrieved successfully

Bodyapplication/json

🟠400

🟠401

🟠403

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://api.fieldedge.com/open-api/v1/employees?offset=undefined&limit=undefined&filter[active]=undefined&filter[role]=undefined'

Response Example

200 - response

{
    "total": 2,
    "limit": 20,
    "offset": 0,
    "data": [
        {
            "id": "FE-EMP-100",
            "name": "John Smith",
            "email": "john.smith@company.com",
            "role": "TECHNICIAN",
            "active": true
        },
        {
            "id": "FE-EMP-101",
            "name": "Jane Doe",
            "email": "jane.doe@company.com",
            "role": "ADMINISTRATOR",
            "active": true
        }
    ]
}

Modified at 2026-06-03 05:20:15

Retrieve customer by phone number

Retrieve an employee by ID