← Employees APIRetrieve a paginated list of employees with advanced filtering. This V2 endpoint extends the V1 list with additional filters (co2e_status, file_id, created_at range) and returns a filter_hash required by the bulk delete by filters endpoint.
Request
Headers
string
required
Your API key for authenticationExample:sk_live_1234567890abcdef
string
required
Your organization UUIDExample:a8315ef3-dd50-43f8-b7ce-d839e68d51fa
Query Parameters
string
Search employees by name or email (partial match)Example:"john"
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 employment situationAvailable values:active, inactive, terminatedExample:situation[]=active
array[string]
Filter by data statusAvailable values:uploaded, loading, error (see Get Employee)Example:status[]=uploaded
array[string]
Filter by how commuting data was collectedAvailable values:manual, qr, form, file_uploadExample:response_medium[]=form
array[string]
Filter by source file UUID(s)Example:file_id[]=550e8400-e29b-41d4-a716-446655440000
string
Filter by emission calculation statusAvailable values:calculated, not_calculatedExample:not_calculated
datetime
Filter employees created on or after this date (ISO 8601)Example:2024-01-01T00:00:00Z
datetime
Filter employees created on or before this date (ISO 8601)Example:2024-12-31T23:59:59Z
integer
default:"1"
Page number for paginationExample:1
integer
default:"10"
Number of items per page (max 100)Example:50
Response
Returns a paginated list of employees (HTTP 200) with a filter_hash for safe bulk operations.
array[object]
Array of employee objects (same structure as V1 list)
Show Employee Object
string
Unique identifier (UUID)
string | null
Employee’s full name
string | null
Employee’s email address
string
Organization UUID
string | null
active, inactive, or terminated
string
uploaded, loading or error
array[object] | null
Commuting periods with CO2e calculations
datetime
Record creation timestamp
datetime | null
Last update timestamp
integer
Total number of employees matching the filters
integer
Current page number
integer
Number of items per page
string
Hash of the applied filters. Pass this to bulk delete by filters to ensure the delete operates on exactly the same result set.
boolean
Capability flag: true means this backend exposes the bulk-*-by-filters endpoint for this list, so the client may offer “select all matching”. false on a backend that only supports bulk delete by explicit ids.