Teambrite
Employees

List employees

GET/v1/employees

Returns your active employees. To find one person, filter by id, email or externalId, and you get them as the only item in data, or an empty data if nobody matches. Filters combine, so an employee has to match every one you send. birthday is null for anyone who has made theirs private.

Needs a key with the employee:read scope.

Query parameters

  • idstring

    Only the employee with this ID.

  • emailstring

    Only the employee with this work email. Capitals don't matter.

  • externalIdstring

    Only the employee with this ID from your own system, as it was imported into Teambrite.

  • searchstring

    Only return employees whose name contains this text.

  • 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 employees.

  • dataarray of objects

    Active employees who match every filter you sent, ordered by ID. Empty if nobody matches.

  • 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.

List programs

Your active reward programs, their audience and what they will pay.

Create an employee

Add someone, with the dates their rewards depend on.

Copyright © 2026