Loading get_getleads_usage
get_getleads_usage

Read the GetLeads plan, remaining credits, and daily/monthly fair-use windows.
# 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)

## get_getleads_usage

Read the GetLeads plan, remaining credits, and daily/monthly fair-use windows.

Use before a large enrichment to check the account can absorb it.

This reads GetLeads live and counts against the pacing gate; do not poll it.

Scopes: integration: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"
    },
    "connectionId": {
      "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",
    "connectionId"
  ],
  "patternProperties": {
    "^(?!(?:workspaceId|connectionId)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "workspaceId",
      "connectionId"
    ]
  }
}
```

### 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"
    },
    "connectionId": {
      "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",
    "connectionId"
  ],
  "patternProperties": {
    "^(?!(?:workspaceId|connectionId)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "workspaceId",
      "connectionId"
    ]
  }
}
```

### Output schema (structuredContent)

```json
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "enum": [
        true
      ]
    },
    "applies": {
      "type": "boolean"
    },
    "plan": {
      "$ref": "#/$defs/ShortText"
    },
    "exempt": {
      "type": "boolean"
    },
    "creditsRemaining": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ]
    },
    "daily": {
      "type": "object",
      "properties": {
        "cap": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "used": {
          "type": "number"
        },
        "remaining": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "period": {
          "$ref": "#/$defs/ShortText"
        },
        "periodStart": {
          "$ref": "#/$defs/ShortText"
        },
        "resetsAt": {
          "$ref": "#/$defs/ShortText"
        }
      },
      "required": [
        "cap",
        "used",
        "remaining",
        "period",
        "periodStart",
        "resetsAt"
      ],
      "patternProperties": {
        "^(?!(?:cap|used|remaining|period|periodStart|resetsAt)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "cap",
          "used",
          "remaining",
          "period",
          "periodStart",
          "resetsAt"
        ]
      }
    },
    "monthly": {
      "type": "object",
      "properties": {
        "cap": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "used": {
          "type": "number"
        },
        "remaining": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "period": {
          "$ref": "#/$defs/ShortText"
        },
        "periodStart": {
          "$ref": "#/$defs/ShortText"
        },
        "resetsAt": {
          "$ref": "#/$defs/ShortText"
        }
      },
      "required": [
        "cap",
        "used",
        "remaining",
        "period",
        "periodStart",
        "resetsAt"
      ],
      "patternProperties": {
        "^(?!(?:cap|used|remaining|period|periodStart|resetsAt)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "cap",
          "used",
          "remaining",
          "period",
          "periodStart",
          "resetsAt"
        ]
      }
    },
    "binding": {
      "anyOf": [
        {
          "$ref": "#/$defs/ShortText"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "ok",
    "applies",
    "plan",
    "creditsRemaining"
  ],
  "patternProperties": {
    "^(?!(?:ok|applies|plan|exempt|creditsRemaining|daily|monthly|binding)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "ok",
      "applies",
      "plan",
      "exempt",
      "creditsRemaining",
      "daily",
      "monthly",
      "binding"
    ]
  },
  "$defs": {
    "ShortText": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    }
  }
}
```

### Underlying API operations

- `getleads.usage`: `GET /v1/workspaces/:workspaceId/integrations/getleads/:connectionId/usage`