read_workspace_usage
Read a workspace's billing-period-aligned usage counters and subscription limits.
# MCP tool reference
1 callable tools.
Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.
Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.
[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)
## read_workspace_usage
Read a workspace's billing-period-aligned usage counters and subscription limits.
Use to report how much of each quota the current workspace has consumed.
Read-only; it never mutates counters or manages the subscription itself.
Scopes: usage:read
Risk: read; confirmation: none; idempotency: none.
### Input schema (personal API key)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"workspaceId"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId"
]
}
]
}
}
```
### Input schema (OAuth / delegated agent)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"workspaceId"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId"
]
}
]
}
}
```
### Output schema (structuredContent)
```json
{
"type": "object",
"properties": {
"usage": {
"type": "object",
"properties": {
"emailsSent": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"connectedInboxes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"activeCampaigns": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"totalContacts": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"emailsSent",
"connectedInboxes",
"activeCampaigns",
"totalContacts"
],
"patternProperties": {
"^(?!(?:emailsSent|connectedInboxes|activeCampaigns|totalContacts)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"emailsSent",
"connectedInboxes",
"activeCampaigns",
"totalContacts"
]
}
},
"workspaceUsage": {
"type": "object",
"properties": {
"emailsSent": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"connectedInboxes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"activeCampaigns": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"totalContacts": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"emailsSent",
"connectedInboxes",
"activeCampaigns",
"totalContacts",
"workspaceId"
],
"patternProperties": {
"^(?!(?:emailsSent|connectedInboxes|activeCampaigns|totalContacts|workspaceId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"emailsSent",
"connectedInboxes",
"activeCampaigns",
"totalContacts",
"workspaceId"
]
}
},
"limits": {
"type": "object",
"properties": {
"maxEmailsPerMonth": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"maxInboxes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"maxCampaigns": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"maxContactsPerCampaign": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"maxEmailsPerMonth",
"maxInboxes",
"maxCampaigns",
"maxContactsPerCampaign"
],
"patternProperties": {
"^(?!(?:maxEmailsPerMonth|maxInboxes|maxCampaigns|maxContactsPerCampaign)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"maxEmailsPerMonth",
"maxInboxes",
"maxCampaigns",
"maxContactsPerCampaign"
]
}
},
"period": {
"type": "object",
"properties": {
"start": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"end": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"start",
"end"
],
"patternProperties": {
"^(?!(?:start|end)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"start",
"end"
]
}
},
"subscription": {
"anyOf": [
{
"type": "object",
"properties": {
"plan": {
"$ref": "#/$defs/ShortText"
},
"status": {
"$ref": "#/$defs/ShortText"
},
"billingCycle": {
"$ref": "#/$defs/ShortText"
},
"periodEnd": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"trialEnd": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"plan",
"status",
"billingCycle",
"periodEnd",
"trialEnd"
],
"patternProperties": {
"^(?!(?:plan|status|billingCycle|periodEnd|trialEnd)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"plan",
"status",
"billingCycle",
"periodEnd",
"trialEnd"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"usage",
"workspaceUsage",
"limits",
"period",
"subscription"
],
"patternProperties": {
"^(?!(?:usage|workspaceUsage|limits|period|subscription)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"usage",
"workspaceUsage",
"limits",
"period",
"subscription"
]
},
"$defs": {
"UtcDateTimeEncoded": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
},
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
```
### Underlying API operations
- `workspaces.usage`: `GET /v1/workspaces/:workspaceId/usage`
Scheduler Zero