Get organization settings
The org’s pay-gap analysis configuration. Requires settings:read.
GET
/settingsResponses
200The effective org settings.
femaleDominatedThresholdnumberpayGapThresholdnumberminTeamSizeinteger401Missing or invalid API key.
errorobjectShow propertiesHide properties
statusstringmessagestring403The API key lacks the scope required for this route.
errorobjectShow propertiesHide properties
statusstringmessagestringRequest
curl -X GET "https://paygap-jaggeman.web.app/api/v1/settings"const response = await fetch("https://paygap-jaggeman.web.app/api/v1/settings", {
method: "GET"
});import requests
response = requests.get(
"https://paygap-jaggeman.web.app/api/v1/settings",
)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"
}
}