Read how many sites the plan allows

get_site_usage

Reads how many sites the default workspace you own has used against its plan's site limit.

POST /v1/get_site_usageScopeworkspaces:readRead only

It reports the default workspace you own, not a workspace you name and not one you are merely a member of. So it answers how close you are to your own limit rather than a question about any particular workspace, and it needs no workspace to run.

The answer gives SitesCount against SiteLimit, the sites the plan includes plus any extra sites bought, with the extras in ExtraSites and CanPurchaseExtraSite saying whether another can be added. Read it before create_site to know whether the next site will be refused. See Limits and quotas.

Request

Call it with a POST to https://api.modulify.ai/v1/get_site_usage. It takes no inputs, so send an empty JSON object or no body at all. The token needs the workspaces:read scope.

It only reads and changes nothing, so retrying it is safe.

curl -X POST https://api.modulify.ai/v1/get_site_usage \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP, the same method is the get_site_usage tool.

Inputs

This tool takes no inputs.

Response

Every call answers with the JSON envelope of success, message, data, code and version. data holds the result described above, and on a method that returns a total, count carries it. The response headers carry the call's X-Request-Id and what is left of your per-minute budget in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Errors explains every status code a call can answer with.