Get quiet employees
/v1/insights/quiet-employeesFinds active employees with no reward in the given number of months, leaving out recent hires. For each one it says whether any program reaches them and when their next reward is due, so you can tell a real gap from timing.
Needs a key with the reward:read scope.
Query parameters
monthsinteger1 to 60 · Default 12How many months without a reward counts as quiet.
limitinteger1 to 100 · Default 50How many to return, up to 100.
cursorstringThe
nextCursorfrom the previous page. Leave it out to start from the beginning.
Response
200: The employees who have gone without a reward.
monthsintegerThe number of months you asked about.
todaydateToday, in your company's time zone.
cutoffDatedateEmployees with no reward since this date are included.
forecastDaysintegerHow far ahead
nextRewardlooks, which your plan sets.totalCountintegerQuiet employees, on every page.
neverRewardedCountintegerOf those, how many have never had a reward.
rewardComingCountintegerHow many have a reward due inside the forecast.
notReachedCountintegerHow many no active program would ever pay.
dataarray of objectsOne page of quiet employees, ordered by ID.
nextCursorstring or nullPass this as
cursorto get the next page.nullon the last page. Treat it as opaque.
Errors
400API_QUERY_INVALID: A query parameter, or an ID in the path, is unknown or not in the right form.401API_KEY_INVALID: The key is missing, wrong, expired or revoked.403API_KEY_SCOPE_MISSING: The key is valid but wasn't given the scope this endpoint needs.PLAN_UPGRADE_REQUIRED: Your plan doesn't include the API.COMPANY_CLOSED: Your company has closed its Teambrite account.429API_KEY_RATE_LIMITED: The key is over 600 requests a minute.COMPANY_RATE_LIMITED: Your company is over its limit of 120 read requests a minute.