Teambrite
Rewards

List upcoming rewards

GET/v1/rewards/upcoming

Returns the rewards due from today, one page at a time, with totals for the whole period. How far ahead you can look depends on your plan: 60 days on Starter and 365 on Enterprise. Each page is worked out when you ask for it, so the totals can change between pages if a program or employee changes.

Needs a key with the reward:read scope.

Query parameters

  • daysinteger1 to 365 · Default 30

    How many days ahead to look, counting today. Your plan may allow fewer, and limitedToDays says so.

  • limitinteger1 to 100 · Default 50

    How many to return, up to 100.

  • cursorstring

    The nextCursor from the previous page. Leave it out to start from the beginning.

Response

200: The forecast.

  • startdate

    The first day covered, in your company's time zone.

  • enddate

    The last day covered.

  • limitedToDaysinteger or null

    Set when you asked for more days than your plan can forecast. It is the number of days you got.

  • currencystring

    Lowercase three-letter currency code, such as usd.

  • rewardCountinteger

    Rewards due across the whole period, on every page.

  • totalMinorinteger

    What they add up to. In minor units, so 2500 is 25.00.

  • programsarray of objects

    The totals by program for the whole period, largest first.

  • dataarray of objects

    One page of the rewards due, earliest first, then by employee ID and program ID.

  • nextCursorstring or null

    Pass this as cursor to get the next page. null on 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.

Remove employees from groups

Take several people out of several groups at once.

Get coverage gaps

Who no birthday or anniversary program reaches.

Copyright © 2026