Skip to content

Overview

This documentation hub serves as the central resource for exploring and integrating with services across the TeamTBM ecosystem. Whether you're building internal tools, third-party integrations, or exploring our public APIs, you'll find comprehensive guides and references here.

Response Format

All API responses are returned in JSON format with a consistent structure:

{
    "success": true,
    "code": 200
}

Standard Fields:

  • success (boolean) - Indicates whether the request was successful
  • code (integer) - Response status code

Error responses follow the same structure and usually contain both a generic message field, along with a detailed error field.

Authentication Methods

Public APIs are available for all to use without authentication. These endpoints provide utility functions intended to aid developers and are not directly related to core TeamTBM services.

Characteristics:

  • No authentication required
  • Stricter rate limiting
  • General-purpose utilities
  • No user-specific data access

Rate Limits: Typically 120 requests per minute per IP address

API Keys provide access to restricted TeamTBM services, including user content and public site data.

Characteristics:

  • Tied to a specific user account
  • Higher rate limits
  • Access to user-linked content
  • Read access to public data

Usage:

Include your API key in the request header:

curl -H "X-API-Key: your_api_key_here" https://api.teamtbm.org/v1/endpoint

Rate Limits: Typically 500 requests per minute per key

OAuth tokens provide authenticated access for account-specific actions such as profile updates and private data management.

Characteristics:

  • User-authorized access
  • Account modification permissions
  • Secure token-based authentication
  • Configurable scopes

Usage:

Include the bearer token in the Authorization header:

curl -H "Authorization: Bearer your_access_token" https://api.teamtbm.org/v1/endpoint

Rate Limits: Typically 250 requests per minute per token

HTTP Status Codes

Standard HTTP status codes are used throughout all APIs:

  • 200 - Success
  • 400 - Bad Request (invalid parameters)
  • 401 - Unauthorized (missing or invalid authentication)
  • 403 - Forbidden (insufficient permissions)
  • 404 - Not Found
  • 429 - Too Many Requests (rate limit exceeded)
  • 500 - Internal Server Error

Versioning

All APIs use URL-based versioning (e.g., /v1/, /v2/). When breaking changes are introduced, a new version will be released while maintaining support for previous versions for a minimum of 6 months.

Support

For issues, questions, or feature requests not covered in this documentation, please contact TeamTBM support through the appropriate channels.