List employees
Returns the calling token’s organization’s employees. Requires the
employees:read scope. Salary and personnummer fields are only included
when the token additionally holds employees:read:pii.
GET
/employeesQuery parameters
departmentstringFilter to a single department name.
limitintegermin 1 · max 500 · default: 100
Responses
200A page of employee records.
dataEmployee[]Show propertiesHide properties
Array of
EmployeeEMAILstring<email>NAMEstringGENDERstringAllowed:
FemaleMaleUnknownDEPARTMENTstringROLEstringSALARY BANDstringBASE SALARYnumberOnly present with the `employees:read:pii` scope.
countinteger401Missing or invalid API key.
errorobjectShow propertiesHide properties
statusstringmessagestring403The API key lacks the scope required for this route.
errorobjectShow propertiesHide properties
statusstringmessagestring429Per-token rate limit exceeded.
errorobjectShow propertiesHide properties
statusstringmessagestringRequest
curl -X GET "https://paygap-jaggeman.web.app/api/v1/employees"const response = await fetch("https://paygap-jaggeman.web.app/api/v1/employees", {
method: "GET"
});import requests
response = requests.get(
"https://paygap-jaggeman.web.app/api/v1/employees",
)Response
{
"data": [
{
"EMAIL": "anna@company.com",
"NAME": "Anna Andersson",
"GENDER": "Female",
"DEPARTMENT": "Engineering",
"ROLE": "Software Engineer",
"SALARY BAND": "Band 3",
"BASE SALARY": 55000
}
],
"count": 42
}{
"error": {
"status": "unauthenticated",
"message": "A valid X-API-Key is required."
}
}{
"error": {
"status": "permission-denied",
"message": "Missing required scope: employees:read"
}
}{
"error": {
"status": "resource-exhausted",
"message": "Too many requests."
}
}