How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Franklin Whole Home

Franklin Whole Home Sites API

Site records — query, list, modify and delete.

Documentation Provider Profile APIs.io OpenAPI GitHub

Franklin Whole Home Sites API is one of 12 APIs that Franklin Whole Home publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sites. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://test-api.franklinwh.com.

3 operations 3 paths 2 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://test-api.franklinwh.com
Authentication
API Key
Contact
FranklinWH Support
Resource Areas
1

Authentication & Security 1

Franklin Whole Home Sites API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (AuthorizationToken). By default, every request must be authenticated.

  • AuthorizationToken — Token returned by POST /api-common/tokenizer (exchange of a cp / ck credential pair).

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Sites 3

Site records — query, list, modify and delete.

GET
/api-common/querySiteInfo
Query Site Information
querySiteInfo 1 param → 200404
GET
/api-common/querySiteList
Query Site List
querySiteList 6 params → 200404
POST
/api-common/modifySite
Modify or Delete a Site
modifySite body → 200404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are NotFoundError (6 properties), ApiEnvelope (3 properties). Each schema is shown below with its type and property counts.

NotFoundError
object
Framework 404 body returned for unknown paths.
6 properties
ApiEnvelope
object
Response envelope used by every operation. Observed live on https://test-api.franklinwh.com.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

franklin-whole-home-sites-api-openapi.yml Raw ↑

Other APIs Franklin Whole Home publishes across the network.

Franklin Whole Home Authentication API
AE Profile APIs.io
Franklin Whole Home Device Data API
AE Profile APIs.io
Franklin Whole Home Devices API
AE Profile APIs.io
Franklin Whole Home Grid Events API
AE Profile APIs.io
Franklin Whole Home Groups API
AE Profile APIs.io
Franklin Whole Home Modification Records API
AE Profile APIs.io
Franklin Whole Home Sunrun API
AE Profile APIs.io
Franklin Whole Home Sunrun Sites API
AE Profile APIs.io
Franklin Whole Home Sunrun System Setup API
AE Profile APIs.io
Franklin Whole Home System Settings API
AE Profile APIs.io
Franklin Whole Home Warnings and Events API
AE Profile APIs.io
#Sites
← Back to F APIs
API Details
ID
franklin-whole-home:franklin-whole-home-sites-api
Base URL
https://test-api.franklinwh.com
Docs
https://api.franklinwh.com/
Provider
Franklin Whole Home
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=franklin-whole-home-sites-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/franklin-whole-home-sites-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Franklin Whole Home Sites API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.