Get organization settings

The org’s pay-gap analysis configuration. Requires settings:read.

GET/settings

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.

Responses

200

The effective org settings.

femaleDominatedThresholdnumber

payGapThresholdnumber

minTeamSizeinteger

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

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Request

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

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

import requests

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

Response

{
  "femaleDominatedThreshold": 0.6,
  "payGapThreshold": 5,
  "minTeamSize": 3
}

{
  "error": {
    "status": "unauthenticated",
    "message": "A valid X-API-Key is required."
  }
}

{
  "error": {
    "status": "permission-denied",
    "message": "Missing required scope: employees:read"
  }
}