Skip to main content
GET
List workers

Authorizations

klef.session
string
cookie
required

Cookie-based session. Obtain by completing the /auth/login/{provider} OAuth flow; the /auth/callback response sets the klef.session cookie that subsequent requests send automatically.

Query Parameters

q
string

Case-insensitive search across name, email, employee id, job, and department.

Required string length: 3 - 100
costCenter
string[]

Filter to workers with an assignment in any of these cost center codes.

department
string[]

Filter to workers with an assignment in any of these department codes.

businessUnit
string[]

Filter to workers with an assignment in any of these business unit codes.

license
string[]

Filter to workers holding any of these licenses, by sku part number.

stage
enum<string>[]

Filter to workers in any of these lifecycle stages.

A stage in a worker's lifecycle that a policy configures behavior for.

Available options:
pre_start,
active,
leave,
departing,
terminated
account
string[]

Filter to workers Klef manages an account for on any of these systems.

A connector: one Klef ships, such as microsoft_entra, or a workspace's own, whose id starts with custom_.

Pattern: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
from
string

Filter to workers whose effective hire date is on or after this day.

to
string

Filter to workers whose effective hire date is on or before this day.

sort
enum<string>

Order the results by this column (default: name).

Available options:
name,
start_date
dir
enum<string>

Sort direction for sort (default: ascending).

Available options:
asc,
desc
cursor
integer<int32>
limit
integer<int32>

Response

OK

results
object[]
required
errors
object[]
required
pagination
null | object
required

Where one page sits in a paged read.