Metabase API

https://www.metabase.com/docs/latest/api
Admin
The Metabase API provides programmatic access to Metabase functionalities, enabling developers to...
Tokens:4,912
Snippets:25
Trust Score:9.8
Update:1 day ago
Show doc for...
Tokens:
Raw
### curl request for GET /api/action

Source: https://www.metabase.com/docs/latest/api#description/api-changelog

Example curl command to call the GET /api/action endpoint. Requires an API key header (X-API-Key) for authentication. The endpoint returns a list of actions.

```curl
curl http://localhost:3000/api/action \
  --header 'X-API-Key: YOUR_SECRET_TOKEN'
```

--------------------------------

### JSON response schema for GET /api/action

Source: https://www.metabase.com/docs/latest/api#description/api-changelog

Example JSON response schema showing the structure of a successful response. Includes fields such as visualization_settings, response_handle, entity_id, parameter_mappings, id, creator, and more. The response is an array of action objects.

```json
[
  {
    "visualization_settings": {},
    "response_handle": "string",
    "entity_id": "string",
    "parameter_mappings": [
      {
        "card_id": 1,
        "parameter_id": "string",
        "target": null
      }
    ],
    "id": 1,
    "creator": {
      "login_attributes": {
        "additionalProperty": null
      },
      "sso_source": "string",
      "jwt_attributes": {
        "additionalProperty": null
      },
      "is_qbnewb": true,
      "user_group_memberships": [
        {
          "entity_id": "string",
          "name": "string"
        }
      ],
      "reset_token": "string",
      "settings": {},
      "deactivated_at": "2026-10-20T16:07:27.610Z",
      "entity_id": "string",
      "is_active": true,
      "last_login": "2026-10-20T16:07:27.610Z",
      "id": 1,
      "email": "string",
      "password_salt": "string",
      "deactivated_with_tenant": true,
      "is_data_analyst": true,
      "locale": "string",
      "updated_at": "2026-10-20T16:07:27.610Z",
      "is_datasetnewb": true,
      "reset_triggered": 1,
      "is_superuser": true,
      "tenant_id": 1,
      "last_name": "string",
      "attributes": {
        "additionalProperty": null
      },
      "first_name": "string",
      "type": "string",
      "date_joined": "2026-10-20T16:07:27.610Z",
      "password": "string",
      "common_name": "string"
    },
    "made_public_by_id": 1,
    "name": "string",
    "archived": true,
    "database_id": 1,
    "updated_at": null,
    "legacy_query": "string",
    "type": "http",
    "template": {
      "body": "string",
      "headers": "string",
      "method": "GET",
      "parameters": [
        {
          "filteringParameters": [
            "string"
          ],
          "mappings": [
            {
              "card_id": "[Max Depth Exceeded]",
              "parameter_id": "[Max Depth Exceeded]",
              "target": "[Max Depth Exceeded]"
            }
          ],
          "sectionId": "string",
          "values_source_config": {
            "card_id": 1,
            "label_field": null,
            "value_field": null,
            "values": null
          },
          "hasVariableTemplateTagTarget": true,
          "display-name": "string",
          "id": "string",
          "position": 1,
          "name": "string",
          "slug": "string",
          "value": null,
          "required": true,
          "values_query_type": "none",
          "type": "text",
          "temporal_units": [
            "day"
          ],
          "target": null,
          "values_source_type": "static-list",
          "options": {
            "case-sensitive": true,
            "include-current": true
          },
          "default": null,
          "isMultiSelect": true
        }
      ],
      "url": "string"
    },
    "error_handle": "string",
    "created_at": null,
    "public_uuid": "string",
    "model_id": 1,
    "disabled": true,
    "parameters": [
      {
        "metabase.actions.models/field-id": 1,
        "filteringParameters": [
          "string"
        ],
        "mappings": [
          {
            "card_id": 1,
            "parameter_id": "string",
            "target": null
          }
        ],
        "sectionId": "string",
        "values_source_config": {
          "card_id": 1,
          "label_field": null,
          "value_field": null,
          "values": null
        },
        "hasVariableTemplateTagTarget": true,
        "display-name": "string",
        "id": "string",
        "position": 1,
        "name": "string",
        "slug": "string",
        "value": null,
        "metabase.actions.models/pk?": true,
        "required": true,
        "values_query_type": "none",
        "type": "text",
        "temporal_units": [
          "day"
        ],
        "is-auto-increment": true,
        "target": null,
        "values_source_type": "static-list",
        "options": {
          "case-sensitive": true,
          "include-current": true
        },
        "default": null,
        "isMultiSelect": true
      }
    ],
    "creator_id": 1,
    "public_uuid_prefix": "string",
    "description": "string"
  }
]
```

--------------------------------

### Generate API docs with Clojure CLI

Source: https://www.metabase.com/docs/latest/api#description/api-changelog

Run this command to generate the API documentation. Requires the Clojure CLI and the Metabase project setup.

```properties
clojure -M:ee:doc api-documentation
```

--------------------------------

### GET /api/action

Source: https://www.metabase.com/docs/latest/api#description/api-changelog

Retrieves a list of actions available in the Metabase instance. This endpoint is part of the /api/action collection.

```APIDOC
## GET /api/action

### Description
Retrieves a list of actions available in the Metabase instance.

### Method
GET

### Endpoint
/api/action

### Authentication
Requires API key authentication via the X-API-Key header.

### Response
#### Success Response (200)
Returns a list of actions.

#### Response Example
```json
[
  {
    "id": 1,
    "name": "Example Action"
  }
]
```
```

--------------------------------

### GET /api/action/public

Source: https://www.metabase.com/docs/latest/api#description/api-changelog

Retrieves a list of public actions. This endpoint is part of the /api/action collection.

```APIDOC
## GET /api/action/public

### Description
Retrieves a list of public actions.

### Method
GET

### Endpoint
/api/action/public

### Authentication
Requires API key authentication via the X-API-Key header.

### Response
#### Success Response (200)
Returns a list of public actions.

#### Response Example
```json
[
  {
    "id": 1,
    "name": "Public Action"
  }
]
```
```

--------------------------------

### GET /api/action

Source: https://www.metabase.com/docs/latest/api#description/api-changelog

Returns actions that can be used for QueryActions. By default lists all viewable actions. Pass optional `?model-id=<model-id>` to limit to actions on a particular model.

```APIDOC
## GET /api/action

### Description
Returns actions that can be used for QueryActions. By default lists all viewable actions. Pass optional `?model-id=<model-id>` to limit to actions on a particular model.

### Method
GET

### Endpoint
/api/action

### Parameters
#### Query Parameters
- **model-id** (integer) - Optional - Valid Card ID. Limits to actions on a particular model.

### Request Example
```curl
curl http://localhost:3000/api/action \
  --header 'X-API-Key: YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (2XX)
- **visualization_settings** (object) - Visualization settings for the action.
- **response_handle** (string) - Response handle.
- **entity_id** (string) - Entity ID.
- **parameter_mappings** (array) - Parameter mappings.
- **id** (integer) - Action ID.
- **creator** (object) - Creator user object.
- **made_public_by_id** (integer) - ID of user who made the action public.
- **name** (string) - Action name.
- **archived** (boolean) - Whether the action is archived.
- **database_id** (integer) - Database ID.
- **updated_at** (string) - Last updated timestamp.
- **legacy_query** (string) - Legacy query.
- **type** (string) - Action type (e.g., "http").
- **template** (object) - HTTP template details.
- **error_handle** (string) - Error handle.
- **created_at** (string) - Creation timestamp.
- **public_uuid** (string) - Public UUID.
- **model_id** (integer) - Model ID.
- **disabled** (boolean) - Whether the action is disabled.
- **parameters** (array) - Action parameters.
- **creator_id** (integer) - Creator user ID.
- **public_uuid_prefix** (string) - Public UUID prefix.
- **description** (string) - Action description.

#### Response Example
```json
[
  {
    "visualization_settings": {},
    "response_handle": "string",
    "entity_id": "string",
    "parameter_mappings": [
      {
        "card_id": 1,
        "parameter_id": "string",
        "target": null
      }
    ],
    "id": 1,
    "creator": {
      "login_attributes": {
        "additionalProperty": null
      },
      "sso_source": "string",
      "jwt_attributes": {
        "additionalProperty": null
      },
      "is_qbnewb": true,
      "user_group_memberships": [
        {
          "entity_id": "string",
          "name": "string"
        }
      ],
      "reset_token": "string",
      "settings": {},
      "deactivated_at": "2026-10-20T16:07:27.610Z",
      "entity_id": "string",
      "is_active": true,
      "last_login": "2026-10-20T16:07:27.610Z",
      "id": 1,
      "email": "string",
      "password_salt": "string",
      "deactivated_with_tenant": true,
      "is_data_analyst": true,
      "locale": "string",
      "updated_at": "2026-10-20T16:07:27.610Z",
      "is_datasetnewb": true,
      "reset_triggered": 1,
      "is_superuser": true,
      "tenant_id": 1,
      "last_name": "string",
      "attributes": {
        "additionalProperty": null
      },
      "first_name": "string",
      "type": "string",
      "date_joined": "2026-10-20T16:07:27.610Z",
      "password": "string",
      "common_name": "string"
    },
    "made_public_by_id": 1,
    "name": "string",
    "archived": true,
    "database_id": 1,
    "updated_at": null,
    "legacy_query": "string",
    "type": "http",
    "template": {
      "body": "string",
      "headers": "string",
      "method": "GET",
      "parameters": [
        {
          "filteringParameters": [
            "string"
          ],
          "mappings": [
            {
              "card_id": "[Max Depth Exceeded]",
              "parameter_id": "[Max Depth Exceeded]",
              "target": "[Max Depth Exceeded]"
            }
          ],
          "sectionId": "string",
          "values_source_config": {
            "card_id": 1,
            "label_field": null,
            "value_field": null,
            "values": null
          },
          "hasVariableTemplateTagTarget": true,
          "display-name": "string",
          "id": "string",
          "position": 1,
          "name": "string",
          "slug": "string",
          "value": null,
          "required": true,
          "values_query_type": "none",
          "type": "text",
          "temporal_units": [
            "day"
          ],
          "target": null,
          "values_source_type": "static-list",
          "options": {
            "case-sensitive": true,
            "include-current": true
          },
          "default": null,
          "isMultiSelect": true
        }
      ],
      "url": "string"
    },
    "error_handle": "string",
    "created_at": null,
    "public_uuid": "string",
    "model_id": 1,
    "disabled": true,
    "parameters": [
      {
        "metabase.actions.models/field-id": 1,
        "filteringParameters": [
          "string"
        ],
        "mappings": [
          {
            "card_id": 1,
            "parameter_id": "string",
            "target": null
          }
        ],
        "sectionId": "string",
        "values_source_config": {
          "card_id": 1,
          "label_field": null,
          "value_field": null,
          "values": null
        },
        "hasVariableTemplateTagTarget": true,
        "display-name": "string",
        "id": "string",
        "position": 1,
        "name": "string",
        "slug": "string",
        "value": null,
        "metabase.actions.models/pk?": true,
        "required": true,
        "values_query_type": "none",
        "type": "text",
        "temporal_units": [
          "day"
        ],
        "is-auto-increment": true,
        "target": null,
        "values_source_type": "static-list",
        "options": {
          "case-sensitive": true,
          "include-current": true
        },
        "default": null,
        "isMultiSelect": true
      }
    ],
    "creator_id": 1,
    "public_uuid_prefix": "string",
    "description": "string"
  }
]
```

### Error Responses
- **4XX** - Client error response.
- **5XX** - Server error response.
```

--------------------------------

### GET /api/action/{action-id}

Source: https://www.metabase.com/docs/latest/api#description/api-changelog

Retrieves a specific action by its ID. This endpoint is part of the /api/action collection.

```APIDOC
## GET /api/action/{action-id}

### Description
Retrieves a specific action by its ID.

### Method
GET

### Endpoint
/api/action/{action-id}

### Authentication
Requires API key authentication via the X-API-Key header.

### Parameters
#### Path Parameters
- **action-id** (integer) - Required - The ID of the action to retrieve.

### Response
#### Success Response (200)
Returns the action object.

#### Response Example
```json
{
  "id": 1,
  "name": "Example Action"
}
```
```

--------------------------------

### POST /api/action

Source: https://www.metabase.com/docs/latest/api#description/api-changelog

Creates a new action in the Metabase instance. This endpoint is part of the /api/action collection.

```APIDOC
## POST /api/action

### Description
Creates a new action in the Metabase instance.

### Method
POST

### Endpoint
/api/action

### Authentication
Requires API key authentication via the X-API-Key header.

### Request Body
- **name** (string) - Required - The name of the action.
- **type** (string) - Required - The type of the action (e.g., "query").
- **dataset_query** (object) - Required - The query definition for the action.

### Request Example
```json
{
  "name": "Example Action",
  "type": "query",
  "dataset_query": {}
}
```

### Response
#### Success Response (200)
Returns the created action object.

#### Response Example
```json
{
  "id": 1,
  "name": "Example Action",
  "type": "query"
}
```
```

--------------------------------

### POST /api/action/{action-id}/execute/values

Source: https://www.metabase.com/docs/latest/api#description/api-changelog

Executes an action with provided values. This endpoint is part of the /api/action collection.

```APIDOC
## POST /api/action/{action-id}/execute/values

### Description
Executes an action with provided values.

### Method
POST

### Endpoint
/api/action/{action-id}/execute/values

### Authentication
Requires API key authentication via the X-API-Key header.

### Parameters
#### Path Parameters
- **action-id** (integer) - Required - The ID of the action to execute.

### Request Body
- **values** (object) - Required - The values to pass to the action.

### Request Example
```json
{
  "values": {
    "field1": "value1"
  }
}
```

### Response
#### Success Response (200)
Returns the execution result.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### POST /api/action/{id}/execute

Source: https://www.metabase.com/docs/latest/api#description/api-changelog

Executes an action. This endpoint is part of the /api/action collection.

```APIDOC
## POST /api/action/{id}/execute

### Description
Executes an action.

### Method
POST

### Endpoint
/api/action/{id}/execute

### Authentication
Requires API key authentication via the X-API-Key header.

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the action to execute.

### Request Body
- **parameters** (object) - Optional - Parameters for the action execution.

### Request Example
```json
{
  "parameters": {}
}
```

### Response
#### Success Response (200)
Returns the execution result.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### POST /api/action/{id}/public_link

Source: https://www.metabase.com/docs/latest/api#description/api-changelog

Creates a public link for an action. This endpoint is part of the /api/action collection.

```APIDOC
## POST /api/action/{id}/public_link

### Description
Creates a public link for an action.

### Method
POST

### Endpoint
/api/action/{id}/public_link

### Authentication
Requires API key authentication via the X-API-Key header.

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the action to create a public link for.

### Response
#### Success Response (200)
Returns the public link details.

#### Response Example
```json
{
  "public_uuid": "abc123"
}
```
```

--------------------------------

### PUT /api/action/{id}

Source: https://www.metabase.com/docs/latest/api#description/api-changelog

Updates an existing action. This endpoint is part of the /api/action collection.

```APIDOC
## PUT /api/action/{id}

### Description
Updates an existing action.

### Method
PUT

### Endpoint
/api/action/{id}

### Authentication
Requires API key authentication via the X-API-Key header.

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the action to update.

### Request Body
- **name** (string) - Optional - The new name of the action.
- **dataset_query** (object) - Optional - The new query definition.

### Request Example
```json
{
  "name": "Updated Action"
}
```

### Response
#### Success Response (200)
Returns the updated action object.

#### Response Example
```json
{
  "id": 1,
  "name": "Updated Action"
}
```
```

--------------------------------

### DELETE /api/action/{action-id}

Source: https://www.metabase.com/docs/latest/api#description/api-changelog

Deletes a specific action by its ID. This endpoint is part of the /api/action collection.

```APIDOC
## DELETE /api/action/{action-id}

### Description
Deletes a specific action by its ID.

### Method
DELETE

### Endpoint
/api/action/{action-id}

### Authentication
Requires API key authentication via the X-API-Key header.

### Parameters
#### Path Parameters
- **action-id** (integer) - Required - The ID of the action to delete.

### Response
#### Success Response (200)
Returns a success message or empty body.

#### Response Example
```json
{}
```
```

--------------------------------

### DELETE /api/action/{id}/public_link

Source: https://www.metabase.com/docs/latest/api#description/api-changelog

Deletes a public link for an action. This endpoint is part of the /api/action collection.

```APIDOC
## DELETE /api/action/{id}/public_link

### Description
Deletes a public link for an action.

### Method
DELETE

### Endpoint
/api/action/{id}/public_link

### Authentication
Requires API key authentication via the X-API-Key header.

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the action whose public link to delete.

### Response
#### Success Response (200)
Returns a success message or empty body.

#### Response Example
```json
{}
```
```
Tokens:
Raw