SchoolScout API
VendorsVendoridUsage

Get vendor usage

Get districts and schools using a specific vendor. Returns entity names and basic info (free); full intelligence requires entity unlock. **Free (0 credits).**

GET
/vendors/{vendorId}/usage

Get districts and schools using a specific vendor. Returns entity names and basic info (free); full intelligence requires entity unlock. Free (0 credits).

AuthorizationBearer <token>

API key (sk_live_... prefix). Generate keys in the UI under Settings > API Keys, then send it as Authorization: Bearer sk_live_...

In: header

Path Parameters

vendorId*string
Formatuuid

Query Parameters

entity_type?string

district or school

state?string

Filter by state abbreviation

limit?integer
Default50
Rangevalue <= 200
offset?integer
Default0

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/vendors/497f6eca-6276-4993-bfeb-53cbbbba6f08/usage"
{
  "data": [
    {
      "entity_type": "string",
      "entity_id": "string",
      "name": "string",
      "state": "string",
      "student_count": 0,
      "category": "string",
      "context": "string",
      "first_seen_at": "string"
    }
  ],
  "pagination": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "has_more": true
  }
}
{
  "error": "string",
  "message": "string",
  "statusCode": -9007199254740991
}