API Reference

Getting started

Make your first request to the Teambrite API.

The API is at https://api.teambrite.com/v1. It takes and returns JSON, and every call acts on the company that owns the key. It's part of the Starter and Enterprise plans.

1. Pick a language

2. Credentials

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

Owners and admins create keys in Teambrite. To follow along, give the key the program:read scope.

3. Make a request

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

How it works

IDs start with what they identify, such as emp_ for an employee, pol_ for a program and grp_ for a group.
Money is in minor units with a currency beside it, so 2500 with usd is $25.00.
Dates without a time are in your company's time zone, such as 2026-11-12. Times are UTC.
Lists come back a page at a time.
Adding a field to a response doesn't count as a breaking change, so ignore fields you don't recognize.

You can also get this API as an OpenAPI document, to generate a client or import it into a tool like Postman.

Send metric values

Report each person's progress so goal programs can reward them.

Authentication

Create an API key, choose what it can do, and send it with your requests.