Programs

List programs

GET/v1/programs

Returns your active reward programs, with how many people each reaches and what it will pay in the next 30 days.

Needs a key with the program:read scope.

Query parameters

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: One page of programs.

dataarray of objects
Your active programs, ordered by 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.

Pagination

How to page through lists and the detail in reports.

List employees

Your active employees, with the IDs you need to send metric values.

Credentials

Stays in this tab and goes only to the Teambrite API. Requests use your real data. Get API key

Request

curl "https://api.teambrite.com/v1/programs" \
  -H "Authorization: Bearer $TEAMBRITE_API_KEY"

Response

{
  "data": [
    {
      "id": "pol_V3nQ8dKcR2tYh6LmXw9Zs4Bf",
      "name": "Birthday reward",
      "occasion": "birthday",
      "amountMinor": 2500,
      "currency": "usd",
      "audienceCount": 184,
      "next30Days": {
        "rewardCount": 16,
        "amountMinor": 40000,
        "nextDate": "2026-11-12"
      }
    }
  ],
  "nextCursor": null
}