Skip to main content
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_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Query Parameters

Search employees by name or email (partial match)Example: "john"
array[string]
Filter by employment situationAvailable values: active, inactive, terminatedExample: situation=active
array[string]
Filter by data statusAvailable values: uploaded, loadingExample: status=uploaded
array[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=bus
array[string]
Filter by how commuting data was collectedAvailable values: manual, qr, form, file_uploadExample: response_medium=form
integer
default:"1"
Page number for paginationExample: 2
integer
default:"50"
Number of items per page (max 100)Example: 50

Response

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 key
Solution: Verify your API key is valid and active. Get a new one from Settings -> API.

404 Not Found

Cause: Organization not found
Solution: Verify that the x-organization-id header contains a valid organization UUID.

422 Validation Error

Cause: Invalid query parameters
Solution: Check that page size is between 1 and 100, and that filter values are valid enums.

Use 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:

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