Team API

The team endpoint returns information about your organisation, plan limits, and current usage.

Get team info

GET /api/v1/team

{
  "team": {
    "name": "Acme Corp",
    "slug": "acme-corp",
    "brand_color": "#8b5cf6",
    "newsletter_cadence": "weekly",
    "member_count": 12,
    "plan": {
      "name": "Pro",
      "key": "pro"
    },
    "usage": {
      "newsletters": {"used": 2, "limit": 10, "unlimited": false},
      "content_blocks": {"used": 34, "limit": -1, "unlimited": true},
      "ai_generations": {"used": 8, "limit": 50, "unlimited": false},
      "team_members": {"used": 12, "limit": 25, "unlimited": false}
    }
  }
}

Usage fields

Field	Description
used	Current count for this billing period
limit	Maximum allowed (-1 means unlimited)
unlimited	Boolean shorthand for limit == -1

Common uses

• Pre-flight checks — Before creating content, check that AI generation limits haven't been reached
• Dashboard integrations — Display plan usage in your own internal tools
• Brand consistency — Read the brand_color to match newsletter content to your brand