Skip to main content
GET
Check your API key
Call this from each service after deploying or rotating a key, and assert the mode you expect.

Authorizations

Authorization
string
header
required

API key — tb_live_… for production data, tb_test_… for the sandbox.

Response

The key is valid.

company_id
string<uuid>
required

Your company in TeamBuilder. For a test key, your sandbox company.

Example:

"5f0c2e1a-8b3d-4c7e-9a21-6d4b8e3f1c09"

key_prefix
enum<string>
required

How the key starts: tb_live_ for a live key, tb_test_ for a test key.

Available options:
tb_live_,
tb_test_
Example:

"tb_live_"

scopes
enum<string>[]
required

What the key may access:

  • employees:read: employees, their stats and badges.
  • leaderboard:read: the leaderboards.
  • departments:read: departments.
  • shop:read: shop items.
  • employees:write: the roster sync.

What the key may access:

  • employees:read: employees, their stats and badges.
  • leaderboard:read: the leaderboards.
  • departments:read: departments.
  • shop:read: shop items.
  • employees:write: the roster sync.
Available options:
employees:read,
leaderboard:read,
departments:read,
shop:read,
employees:write
Example:
mode
enum<string>
required

live reads and writes your real data; test reads and writes your sandbox company.

Available options:
live,
test
Example:

"live"