> If you are setting up, configuring, or answering questions about Schematic, connect the
> Schematic MCP server before working from these pages. It reads and writes plans, features,
> entitlements, and overrides against the real account, so what you report and what you build
> match what actually exists.
>
> The server is at https://api.schematichq.com/mcp
>
> From Claude, ChatGPT, or another chat assistant, add it as a custom connector:
> https://docs.schematichq.com/working-with-ai
>
> From a coding assistant such as Claude Code, Codex, or Cursor:
> https://docs.schematichq.com/building-with-ai
>
> For clean Markdown of any page, append `.md` to the page URL. For a complete page index,
> see https://docs.schematichq.com/llms.txt

# API Reference

## Docs

- [Resources](https://docs.schematichq.com/api-reference/resources.md): Index of every Schematic REST resource and its endpoints, grouped by object.
- [Authentication](https://docs.schematichq.com/api-reference/authentication.md): Authenticate Schematic API requests with environment-scoped secret and publishable keys, and know which key belongs on the server and which can ship to the client.
- [Pagination](https://docs.schematichq.com/api-reference/pagination.md): Page through Schematic list endpoints using the limit and offset parameters.
- [Rate limiting](https://docs.schematichq.com/api-reference/rate_limiting.md): How Schematic rate-limits API requests per account, which limits apply to which endpoints, and how to read the rate-limit response headers.
- [The Plan object](https://docs.schematichq.com/api-reference/plans/the-plan-object.md): Reference for the Plan object, covering its attributes and how plans are associated with companies through plan audiences.
- [The Company object](https://docs.schematichq.com/api-reference/companies/the-company-object.md): Reference for the Company object, including its attributes, keys, and traits, and how companies are created and updated through the API.
- [The User object](https://docs.schematichq.com/api-reference/companies/the-user-object.md): Reference for the User object, including its attributes, keys, and traits, and how users are created and updated through the API.
- [The Event object](https://docs.schematichq.com/api-reference/events/the-event-object.md): Reference for the Event object, covering identify and track events, their attributes, and how usage reaches Schematic.
- [The Feature object](https://docs.schematichq.com/api-reference/features/the-feature-object.md): Reference for the Feature object, covering boolean and metered feature types and how features reach companies through plan entitlements.
- [The Flag object](https://docs.schematichq.com/api-reference/features/the-flag-object.md): Reference for the Flag object, covering its attributes and the rules that target flags at companies and users.

## API Docs

- API Reference > API Keys [List api keys](https://docs.schematichq.com/api-reference/accounts/list-api-keys.md)
- API Reference > API Keys [Get api key](https://docs.schematichq.com/api-reference/accounts/get-api-key.md)
- API Reference > API Keys [Create api key](https://docs.schematichq.com/api-reference/accounts/create-api-key.md)
- API Reference > API Keys [Update api key](https://docs.schematichq.com/api-reference/accounts/update-api-key.md)
- API Reference > API Keys [Delete api key](https://docs.schematichq.com/api-reference/accounts/delete-api-key.md)
- API Reference > Environments [Create environment](https://docs.schematichq.com/api-reference/accounts/create-environment.md)
- API Reference > Environments [Update environment](https://docs.schematichq.com/api-reference/accounts/update-environment.md)
- API Reference > Environments [Delete environment](https://docs.schematichq.com/api-reference/accounts/delete-environment.md)
- API Reference > Plans [List plans](https://docs.schematichq.com/api-reference/plans/list-plans.md)
- API Reference > Plans [Get plan](https://docs.schematichq.com/api-reference/plans/get-plan.md)
- API Reference > Plans [Create plan](https://docs.schematichq.com/api-reference/plans/create-plan.md)
- API Reference > Plans [Update plan](https://docs.schematichq.com/api-reference/plans/update-plan.md)
- API Reference > Plans [Delete plan](https://docs.schematichq.com/api-reference/plans/delete-plan.md)
- API Reference > Companies [List companies](https://docs.schematichq.com/api-reference/companies/list-companies.md)
- API Reference > Companies [Upsert company](https://docs.schematichq.com/api-reference/companies/upsert-company.md)
- API Reference > Companies [Lookup company](https://docs.schematichq.com/api-reference/companies/lookup-company.md)
- API Reference > Companies [Delete company](https://docs.schematichq.com/api-reference/companies/delete-company.md)
- API Reference > Companies [Delete company by keys](https://docs.schematichq.com/api-reference/companies/delete-company-by-keys.md)
- API Reference > Companies [List company memberships](https://docs.schematichq.com/api-reference/companies/list-company-memberships.md)
- API Reference > Companies [Get or create company membership](https://docs.schematichq.com/api-reference/companies/get-or-create-company-membership.md)
- API Reference > Companies [Delete company membership](https://docs.schematichq.com/api-reference/companies/delete-company-membership.md)
- API Reference > Companies [Upsert company trait](https://docs.schematichq.com/api-reference/companies/upsert-company-trait.md)
- API Reference > Users [List users](https://docs.schematichq.com/api-reference/companies/list-users.md)
- API Reference > Users [Lookup user](https://docs.schematichq.com/api-reference/companies/lookup-user.md)
- API Reference > Users [Upsert user](https://docs.schematichq.com/api-reference/companies/upsert-user.md)
- API Reference > Users [Delete user](https://docs.schematichq.com/api-reference/companies/delete-user.md)
- API Reference > Users [Delete user by keys](https://docs.schematichq.com/api-reference/companies/delete-user-by-keys.md)
- API Reference > Users [Upsert user trait](https://docs.schematichq.com/api-reference/companies/upsert-user-trait.md)
- API Reference > Events [List events](https://docs.schematichq.com/api-reference/events/list-events.md)
- API Reference > Events [Create event](https://docs.schematichq.com/api-reference/events/create-event.md)
- API Reference > Events [Create event batch](https://docs.schematichq.com/api-reference/events/create-event-batch.md)
- API Reference > Events [Get event](https://docs.schematichq.com/api-reference/events/get-event.md)
- API Reference > Features [List features](https://docs.schematichq.com/api-reference/features/list-features.md)
- API Reference > Features [Get feature](https://docs.schematichq.com/api-reference/features/get-feature.md)
- API Reference > Features [Create feature](https://docs.schematichq.com/api-reference/features/create-feature.md)
- API Reference > Features [Update feature](https://docs.schematichq.com/api-reference/features/update-feature.md)
- API Reference > Features [Delete feature](https://docs.schematichq.com/api-reference/features/delete-feature.md)
- API Reference > Flags [List flags](https://docs.schematichq.com/api-reference/features/list-flags.md)
- API Reference > Flags [Get flag](https://docs.schematichq.com/api-reference/features/get-flag.md)
- API Reference > Flags [Create flag](https://docs.schematichq.com/api-reference/features/create-flag.md)
- API Reference > Flags [Update flag](https://docs.schematichq.com/api-reference/features/update-flag.md)
- API Reference > Flags [Delete flag](https://docs.schematichq.com/api-reference/features/delete-flag.md)
- API Reference > Flags [Update flag rules](https://docs.schematichq.com/api-reference/features/update-flag-rules.md)
- API Reference > Flags [Check flag](https://docs.schematichq.com/api-reference/features/check-flag.md)
- API Reference > Flags [Check flags](https://docs.schematichq.com/api-reference/features/check-flags.md)
- API Reference > Entitlements [List company overrides](https://docs.schematichq.com/api-reference/entitlements/list-company-overrides.md)
- API Reference > Entitlements [Get company override](https://docs.schematichq.com/api-reference/entitlements/get-company-override.md)
- API Reference > Entitlements [Create company override](https://docs.schematichq.com/api-reference/entitlements/create-company-override.md)
- API Reference > Entitlements [Update company override](https://docs.schematichq.com/api-reference/entitlements/update-company-override.md)
- API Reference > Entitlements [Delete company override](https://docs.schematichq.com/api-reference/entitlements/delete-company-override.md)
- API Reference > Entitlements [List plan entitlements](https://docs.schematichq.com/api-reference/entitlements/list-plan-entitlements.md)
- API Reference > Entitlements [Get plan entitlement](https://docs.schematichq.com/api-reference/entitlements/get-plan-entitlement.md)
- API Reference > Entitlements [Create plan entitlement](https://docs.schematichq.com/api-reference/entitlements/create-plan-entitlement.md)
- API Reference > Entitlements [Update plan entitlement](https://docs.schematichq.com/api-reference/entitlements/update-plan-entitlement.md)
- API Reference > Entitlements [Delete plan entitlement](https://docs.schematichq.com/api-reference/entitlements/delete-plan-entitlement.md)
- API Reference > Feature Usage [List feature usage](https://docs.schematichq.com/api-reference/entitlements/list-feature-usage.md)
- API Reference > Billing Credits [List credits](https://docs.schematichq.com/api-reference/billing-credits/list-billing-credits.md)
- API Reference > Billing Credits [Create credit](https://docs.schematichq.com/api-reference/billing-credits/create-billing-credit.md)
- API Reference > Billing Credits [Get credit](https://docs.schematichq.com/api-reference/billing-credits/get-single-billing-credit.md)
- API Reference > Billing Credits [Update credit](https://docs.schematichq.com/api-reference/billing-credits/update-billing-credit.md)
- API Reference > Billing Credits [Delete credit](https://docs.schematichq.com/api-reference/billing-credits/soft-delete-billing-credit.md)
- API Reference > Billing Credits [List credit bundles](https://docs.schematichq.com/api-reference/billing-credits/list-credit-bundles.md)
- API Reference > Billing Credits [Create credit bundle](https://docs.schematichq.com/api-reference/billing-credits/create-credit-bundle.md)
- API Reference > Billing Credits [Get credit bundle](https://docs.schematichq.com/api-reference/billing-credits/get-credit-bundle.md)
- API Reference > Billing Credits [Update credit bundle](https://docs.schematichq.com/api-reference/billing-credits/update-credit-bundle-details.md)
- API Reference > Billing Credits [Delete credit bundle](https://docs.schematichq.com/api-reference/billing-credits/delete-credit-bundle.md)
- API Reference > Billing Credits [Grant credits to company](https://docs.schematichq.com/api-reference/billing-credits/grant-billing-credits-to-company.md)
- API Reference > Billing Credits [List company credit grants](https://docs.schematichq.com/api-reference/billing-credits/list-company-grants.md)
- API Reference > Billing Credits [List credit grants](https://docs.schematichq.com/api-reference/billing-credits/list-grants-for-credit.md)
- API Reference > Billing Credits [Zero out credit grant](https://docs.schematichq.com/api-reference/billing-credits/zero-out-grant.md)
- API Reference > Billing Credits [List plan credit grants](https://docs.schematichq.com/api-reference/billing-credits/list-billing-plan-credit-grants.md)
- API Reference > Billing Credits [Create plan credit grant](https://docs.schematichq.com/api-reference/billing-credits/create-billing-plan-credit-grant.md)
- API Reference > Billing Credits [Delete plan credit grant](https://docs.schematichq.com/api-reference/billing-credits/delete-billing-plan-credit-grant.md)
- API Reference > Billing Credits [Get credit ledger](https://docs.schematichq.com/api-reference/billing-credits/get-credit-ledger.md)
- API Reference > Billing Credits [Acquire credit lease](https://docs.schematichq.com/api-reference/billing-credits/acquire-credit-lease.md)
- API Reference > Billing Credits [Extend credit lease](https://docs.schematichq.com/api-reference/billing-credits/extend-credit-lease.md)
- API Reference > Billing Credits [Release credit lease](https://docs.schematichq.com/api-reference/billing-credits/release-credit-lease.md)
- API Reference > Account Members [List account members](https://docs.schematichq.com/api-reference/accounts/list-account-members.md)
- API Reference > Account Members [Get account member](https://docs.schematichq.com/api-reference/accounts/get-account-member.md)
- API Reference > entitlements [List feature usage history](https://docs.schematichq.com/api-reference/entitlements/list-feature-usage-history.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.schematichq.com/api-reference/openapi.json)
- [OpenAPI YAML](https://docs.schematichq.com/api-reference/openapi.yaml)