# FranchiseSEE Docs

> Guides and reference for FranchiseSEE: connecting AI assistants over MCP, the REST API, enterprise SSO, and how SEEScore works. Every page is also available as markdown at the URLs below.

## AI & Connectors

- [Overview](https://franchisesee.com/docs/ai/overview.md): What connecting an AI app to FranchiseSEE does, and whether to connect by signing in or with an API token.
- [Connect by signing in](https://franchisesee.com/docs/ai/sign-in.md): Connect Claude, ChatGPT or a coding tool with your usual FranchiseSEE login. Read-only, nothing to install.
- [Claude](https://franchisesee.com/docs/ai/claude.md): Connect FranchiseSEE to Claude and ask about your stores' sales, labor, menu and scores in plain language. Read-only, signed in with your FranchiseSEE login.
- [ChatGPT](https://franchisesee.com/docs/ai/chatgpt.md): Add FranchiseSEE to ChatGPT as a custom MCP server and sign in with your FranchiseSEE login.
- [Developer tools](https://franchisesee.com/docs/ai/developer-tools.md): Connect Claude Code, Cursor, Codex and other coding tools to FranchiseSEE by signing in.
- [Connect with an API token](https://franchisesee.com/docs/ai/api-tokens.md): Use a personal API token for the admin server, apps that can't sign in, scripts and IT-managed setups.
- [Token clients](https://franchisesee.com/docs/ai/token-clients.md): Configure GitHub Copilot, Claude Code, Claude Desktop through mcp-remote and other MCP clients with a personal API token.
- [Data scope and permissions](https://franchisesee.com/docs/ai/data-scope-and-permissions.md): What a connected AI app can see and do for HQ and franchisee accounts, and the switches HQ controls.
- [Example prompts](https://franchisesee.com/docs/ai/example-prompts.md): Questions to ask a connected AI app, from quick lookups to dashboards and bulk changes, and the guided prompts.
- [Troubleshooting](https://franchisesee.com/docs/ai/troubleshooting.md): Fixes for the common problems connecting an AI app to FranchiseSEE and using its tools.
- [MCP tool reference](https://franchisesee.com/docs/ai/tools.md): Every tool on the FranchiseSEE MCP servers, with its arguments.

## REST API

- [Getting started](https://franchisesee.com/docs/api/getting-started.md): Create an API token, make your first request, and learn what each token permission allows.
- [Querying collections](https://franchisesee.com/docs/api/querying.md): Page through, filter, sort and expand the resource collections (locations, districts, categories, groups and users).
- [Errors](https://franchisesee.com/docs/api/errors.md): The status codes the API returns, what each one means, and how to handle it.
- [Get Authenticated User](https://franchisesee.com/docs/api/reference/get-authenticated-user.md): `GET /api/user`
- [Get Metrics](https://franchisesee.com/docs/api/reference/list-metrics.md): `GET /api/v1/data/metrics`
- [Get Sources](https://franchisesee.com/docs/api/reference/list-sources.md): `GET /api/v1/data/sources`
- [Get Periods](https://franchisesee.com/docs/api/reference/list-periods.md): `GET /api/v1/data/periods`
- [Get Leaderboard](https://franchisesee.com/docs/api/reference/get-leaderboard.md): `GET /api/v1/data/leaderboard`
- [Query Metric Value](https://franchisesee.com/docs/api/reference/query-metric-value.md): `GET /api/v1/data/metrics/query`
- [Query Metric Trendline](https://franchisesee.com/docs/api/reference/query-metric-trendline.md): `GET /api/v1/data/metrics/trendline`
- [List Risk Findings](https://franchisesee.com/docs/api/reference/list-risk-findings.md): `GET /api/v1/risk/findings`
- [Get Locations](https://franchisesee.com/docs/api/reference/list-locations.md): `GET /api/v1/locations`
- [Create Location](https://franchisesee.com/docs/api/reference/create-location.md): `POST /api/v1/locations`
- [Get Location](https://franchisesee.com/docs/api/reference/get-location.md): `GET /api/v1/locations/{id}`
- [Patch Location](https://franchisesee.com/docs/api/reference/update-location.md): `PATCH /api/v1/locations/{id}`
- [Delete Location](https://franchisesee.com/docs/api/reference/delete-location.md): `DELETE /api/v1/locations/{id}`
- [Bulk Assign Locations to Districts](https://franchisesee.com/docs/api/reference/bulk-assign-location-districts.md): `POST /api/v1/locations/bulk-district-assignments`
- [Sync Location Groups](https://franchisesee.com/docs/api/reference/sync-location-location-groups.md): `PUT /api/v1/locations/{id}/location-groups`
- [Get Location Groups](https://franchisesee.com/docs/api/reference/list-location-groups.md): `GET /api/v1/location-groups`
- [Create Location Group](https://franchisesee.com/docs/api/reference/create-location-group.md): `POST /api/v1/location-groups`
- [Get Location Group](https://franchisesee.com/docs/api/reference/get-location-group.md): `GET /api/v1/location-groups/{id}`
- [Patch Location Group](https://franchisesee.com/docs/api/reference/update-location-group.md): `PATCH /api/v1/location-groups/{id}`
- [Delete Location Group](https://franchisesee.com/docs/api/reference/delete-location-group.md): `DELETE /api/v1/location-groups/{id}`
- [Get Districts](https://franchisesee.com/docs/api/reference/list-districts.md): `GET /api/v1/districts`
- [Create District](https://franchisesee.com/docs/api/reference/create-district.md): `POST /api/v1/districts`
- [Get District](https://franchisesee.com/docs/api/reference/get-district.md): `GET /api/v1/districts/{id}`
- [Patch District](https://franchisesee.com/docs/api/reference/update-district.md): `PATCH /api/v1/districts/{id}`
- [Delete District](https://franchisesee.com/docs/api/reference/delete-district.md): `DELETE /api/v1/districts/{id}`
- [Get Location Categories](https://franchisesee.com/docs/api/reference/list-location-categories.md): `GET /api/v1/location-categories`
- [Create Location Category](https://franchisesee.com/docs/api/reference/create-location-category.md): `POST /api/v1/location-categories`
- [Get Location Category](https://franchisesee.com/docs/api/reference/get-location-category.md): `GET /api/v1/location-categories/{id}`
- [Patch Location Category](https://franchisesee.com/docs/api/reference/update-location-category.md): `PATCH /api/v1/location-categories/{id}`
- [Delete Location Category](https://franchisesee.com/docs/api/reference/delete-location-category.md): `DELETE /api/v1/location-categories/{id}`
- [Get Users](https://franchisesee.com/docs/api/reference/list-users.md): `GET /api/v1/users`
- [Bulk Add Location Groups to Users](https://franchisesee.com/docs/api/reference/bulk-add-user-location-groups.md): `POST /api/v1/users/bulk-location-groups`
- [Get User](https://franchisesee.com/docs/api/reference/get-user.md): `GET /api/v1/users/{id}`
- [Patch User](https://franchisesee.com/docs/api/reference/update-user.md): `PATCH /api/v1/users/{id}`
- [Delete User](https://franchisesee.com/docs/api/reference/delete-user.md): `DELETE /api/v1/users/{id}`
- [Sync Location Groups](https://franchisesee.com/docs/api/reference/sync-user-location-groups.md): `PUT /api/v1/users/{id}/location-groups`
- [Get Orders](https://franchisesee.com/docs/api/reference/list-orders.md): `GET /api/v1/orders`
- [Get Order](https://franchisesee.com/docs/api/reference/get-order.md): `GET /api/v1/orders/{external_id}`
- [Submit Custom Metric Values](https://franchisesee.com/docs/api/reference/submit-custom-metric-values.md): `POST /api/custom-metrics`

## SSO & Users

- [Enterprise SSO onboarding](https://franchisesee.com/docs/sso/enterprise-sso-onboarding.md): How users sign in when your company connects its identity provider to FranchiseSEE, for corporate-email and personal-email users.
- [User access model](https://franchisesee.com/docs/sso/user-access-model.md): How HQ and franchisee users are scoped to locations, and why a franchisee has either one direct location or location groups, never both.

## Concepts

- [SEEScore](https://franchisesee.com/docs/concepts/seescore.md): How the composite SEEScore combines weighted metrics into one number from 25 to 200 for every location.