List Employees
List Employees
Retrieve all employees with filtering and pagination support
GET
List Employees
List Employees
Retrieve a paginated list of employees in your organization with support for filtering and searching.Request
Headers
string
required
Your API key for authenticationExample:
sk_live_1234567890abcdefstring
required
Your organization UUIDExample:
a8315ef3-dd50-43f8-b7ce-d839e68d51faQuery Parameters
string
Search employees by name or email (partial match)Example:
"john"array[string]
Filter by employment situationAvailable values:
active, inactive, terminatedExample: situation=activearray[string]
Filter by data statusAvailable values:
uploaded, loadingExample: status=uploadedarray[string]
Filter by transport type used in commuting periodsAvailable values:
car, bus, train, metro, tram, motorbike, bicycle, walking, telecommuting, electric_kick_scooter, trolleybusExample: transport_type=car&transport_type=busarray[string]
Filter by how commuting data was collectedAvailable values:
manual, qr, form, file_uploadExample: response_medium=forminteger
default:"1"
Page number for paginationExample:
2integer
default:"50"
Number of items per page (max 100)Example:
50Response
array[object]
Array of employee objects
integer
Total number of employees matching the filter
integer
Current page number
integer
Number of items per page
Example
Successful Response
Common Errors
401 Unauthorized
Cause: Missing or invalid API key404 Not Found
Cause: Organization not foundx-organization-id header contains a valid organization UUID.
422 Validation Error
Cause: Invalid query parametersUse Cases
Get All Active Employees
Retrieve only employees currently working:Calculate Total Category 7 Emissions
Sum up all employee commuting emissions:Search Employees by Name
Find employees matching a search term:Filter by Transport Mode
Find employees using specific transport:Pagination Guide
Navigate through large employee lists efficiently:Related Endpoints
Get Employee
Get a specific employee by ID
Create Employee
Add a new employee to your organization
Update Employee
Modify employee details
Commuting Periods
Manage commuting periods