Skip to main content
The Metabase API provides a comprehensive REST interface for programmatically interacting with your Metabase instance. You can use it to create dashboards, execute queries, manage users, and automate workflows.

​
Base URL

All API endpoints are relative to your Metabase instance URL: 
https://your-metabase-instance.com/api

​
Authentication

Most API endpoints require authentication. Metabase supports session-based authentication using API keys or email/password credentials. See the authentication guide for detailed information.

​
API endpoints

The Metabase API is organized into the following categories:

​
Core resources

  • Database - Manage database connections and metadata (25 endpoints)
  • Card - Create and manage questions/cards (16 endpoints)
  • Dashboard - Create and manage dashboards (20 endpoints)
  • Collection - Organize content in collections (12 endpoints)
  • Dataset - Execute queries and retrieve data (8 endpoints)

​
User management

  • User - Manage user accounts (7 endpoints)
  • Session - Handle authentication sessions (7 endpoints)
  • Permissions - Configure user permissions (9 endpoints)

​
Sharing and automation

  • Public - Access publicly shared content (23 endpoints)
  • Embedding - Embed Metabase content in applications
  • Actions - Execute database actions (7 endpoints)

​
Configuration

​
Response format

API responses are returned in JSON format. Successful responses include a 2XX status code, while errors return 4XX or 5XX status codes.

​
Success response

{
  "id": 123,
  "name": "Sample Dashboard",
  "created_at": "2024-03-15T10:30:00Z"
}

​
Error response

{
  "message": "Invalid credentials",
  "error": true
}

​
Common status codes

​
200 OK
success
Request succeeded
​
201 Created
success
Resource successfully created
​
204 No Content
success
Request succeeded with no response body
​
400 Bad Request
error
Invalid request parameters
​
401 Unauthorized
error
Authentication required or invalid credentials
​
403 Forbidden
error
Insufficient permissions
​
404 Not Found
error
Resource not found
​
500 Internal Server Error
error
Server error occurred

​
Rate limits

See the rate limits documentation for information about API rate limiting and best practices.

​
Getting help

If you encounter issues or have questions:
  • Check the specific endpoint documentation for detailed parameter information
  • Review error messages carefully - they often include helpful debugging information
  • Visit the Metabase discussion forum for community support
  • Report bugs on GitHub

Build docs developers (and LLMs) love

Get started for freeTalk to us