Metabase API documentation

These reference files were generated from source comments by running:

clojure -M:ee:run api-documentation

About the Metabase API

• The API is subject to change. We rarely change API endpoints, and almost never remove them, but if you write code that relies on the API, there’s a chance you might have to update your code in the future.
• The API isn’t versioned. So don’t expect to stay on a particular version of Metabase in order to use a “stable” API.

API live docs

You can view live OpenAPI docs, served via RapiDoc, from your running Metabase at /api/docs. So if your Metabase is at https://www.your-metabase.com you could access them at https://www.your-metabase.com/api/docs.

API tutorial

Check out an introduction to the Metabase API.

API keys

Create keys to authenticate programmatic requests to your Metabase. See API keys.

API changelog

See the API changelog.

API endpoints

* indicates endpoints used for features available on Pro and Enterprise plans.

• Action
• Activity
• Advanced config logs*
• Advanced permissions application*
• Advanced permissions impersonation*
• Alert
• API key
• Audit app user*
• Automagic dashboards
• Bookmark
• Cache
• Card
• Collection
• Content verification review*
• Dashboard
• Database
• Dataset
• Email
• Embed
• Field
• GeoJSON
• Google
• LDAP
• Legacy metric
• LLM Auto-description*
• Login history
• Metabot
• Model index
• Native query snippet
• Notify
• Permissions
• Persist
• Premium features
• Preview embed
• Public
• Pulse
• Revision
• Sandbox GTAP*
• Sandbox table*
• Sandbox user*
• SCIM*
• Search
• Segment
• Serialization*
• Session
• Setting
• Setup
• Slack
• SSO*
• SSO SAML
• Table
• Task
• Tiles
• Timeline
• Timeline event
• Upload management*
• User
• Util