Skip to main content
Read-only view of the team your API key belongs to: identity, effective plan, and plan limits with current usage. Call this before creating a watchlist to know whether the create will hit the plan limit (402) instead of finding out from the error. No request parameters. GET only.

Response Fields

object
Team identity: id, name, created_at, timezone_string, and intention.
string
The effective plan after expiry is applied: one of free, pro, growth, expert, ultimate. If plan.configured is a paid plan but plan.expiry is in the past, plan.type is free.
string
The plan as configured, before expiry is considered.
boolean
When true, plan limits are not enforced for this team and every max in limits is null.
object
max watchlists allowed on the effective plan (all four types combined) and used, the current count. max is null when limits are bypassed. When used >= max, the next watchlist create returns 402.
object
Maximum and current team member count.
object
Maximum posts collected per watchlist per week on the effective plan.
object
Maximum active auto-engagement rules per watchlist on the effective plan.

Error Responses