Teams

GET

/team

Authentication API Token Required

Returns information about your team including subscription status and user role.

Request

Response (200)

Response Fields

Field	Type	Description
team.id	integer	Unique team identifier
team.name	string	Team name
team.user_role	string	Current user's role in the team (admin, member)
team.owner	object	Team owner information
team.owner.id	integer	Owner user ID
team.owner.name	string	Owner user name
team.subscription	object	Team subscription details
team.subscription.plan	string	Current subscription plan
team.subscription.status	string	Subscription status (active, past_due, canceled, etc.)
team.subscription.trial_ends_at	string\|null	Trial end date (ISO 8601) or null if not in trial
team.subscription.is_paused	boolean	Whether the subscription is paused

Response Example

{
    "team": {
        "id": 456,
        "name": "My Content Team",
        "user_role": "admin",
        "owner": {
            "id": 123,
            "name": "John Doe"
        },
        "subscription": {
            "plan": "Creator",
            "status": "active",
            "trial_ends_at": null,
            "is_paused": false
        }
    }
}

GET

/team/credits

Authentication API Token Required

Returns your team's current credit balance and usage information.

Request

Response (200)

Response Fields

Field	Type	Description
credits.current_credits	integer	Current available credits
credits.plan_credits	integer	Total credits allocated for this period
credits.credits_used_this_period	integer	Credits consumed in the current period
credits.credits_remaining	integer	Credits remaining in the current period
credits.credits_expire_at	string	ISO 8601 timestamp when current credits expire
credits.next_credit_refresh	string	ISO 8601 timestamp of next credit refresh

Response Example

{
    "credits": {
        "current_credits": 850,
        "plan_credits": 1000,
        "credits_used_this_period": 150,
        "credits_remaining": 850,
        "credits_expire_at": "2026-02-28T00:00:00Z",
        "next_credit_refresh": "2026-03-01T00:00:00Z"
    }
}

GET

/team/tokens

Authentication API Token Required

List all API tokens for the current team. Team admin required.

Request

Response (200)

Response Fields

Field	Type	Description
tokens	array	Array of token objects
tokens[].id	integer	Token identifier
tokens[].name	string	Human-readable token name
tokens[].abilities	array	Array of permission strings
tokens[].last_used_at	string\|null	ISO 8601 last usage timestamp (null if never used)

Response Example

{
    "tokens": [
        {
            "id": 123,
            "name": "Zapier Integration",
            "abilities": [
                "intel:read",
                "scripts:read"
            ],
            "last_used_at": "2026-02-01T18:22:00Z"
        }
    ]
}

POST

/team/tokens

Authentication API Token Required

Create a new API token. Team admin required.

Request

Request Body

{
    "name": "string (required) - Human-readable name for the token",
    "abilities": "array (required) - Abilities to grant the token, e.g., [\"intel:read\", \"scripts:write\"]"
}

Response (201)

Response Fields

Field	Type	Description
token.id	integer	Token identifier
token.name	string	Token name as provided
token.token	string	The full API token (shown only when created)
token.abilities	array	Granted abilities

Response Example

{
    "token": {
        "id": 456,
        "name": "Automation Token",
        "abilities": [
            "intel:read",
            "scripts:read",
            "channels:read"
        ],
        "token": "plain-text-token-value"
    }
}

DELETE

/team/tokens/{token}

Authentication API Token Required

Delete a token by ID. Team admin required.

Request

Parameters

Name	Type	Description
token	integer	The token ID to delete (path parameter)

Response (200)

Response Fields

Field	Type	Description
message	string	Success confirmation message

Response Example

{
    "message": "Token deleted successfully"
}