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/employees

Authorization

X-API-KeyAPI key · headerrequired

Admin-issued API key, created under Settings → API access; the secret is shown exactly once. The key is bound to one organization and a set of scopes.

Query parameters

departmentstring

Filter to a single department name.

limitinteger

min 1 · max 500 · default: 100

Responses

200

A page of employee records.

dataEmployee[]

Show properties

Array of Employee

EMAILstring<email>

NAMEstring

GENDERstring

Allowed:FemaleMaleUnknown

DEPARTMENTstring

ROLEstring

SALARY BANDstring

BASE SALARYnumber

Only present with the employees:read:pii scope.

countinteger

401

Missing or invalid API key.

errorobject

Show properties

statusstring

messagestring

403

The API key lacks the scope required for this route.

errorobject

Show properties

statusstring

messagestring

429

Per-token rate limit exceeded.

errorobject

Show properties

statusstring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

departmentqueryFilter to a single department name.limitquery

Request

curl -X GET "https://app.novro.se/api/v1/employees" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch("https://app.novro.se/api/v1/employees", {
  method: "GET",
  headers: {
    "X-API-Key": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "https://app.novro.se/api/v1/employees",
    headers={
        "X-API-Key": "YOUR_API_KEY"
    },
)

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."
  }
}