---
title: "GET /api/ee/erd"
method: GET
path: "/api/ee/erd"
tags: ["/api/ee/erd"]
---

# GET /api/ee/erd

`GET /api/ee/erd`

## Request

- Base URL: `` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/ee/erd`
- Auth: API key in header `X-API-Key`

Return an Entity Relationship Diagram (ERD) for tables and their FK relationships.
  When `table-ids` is provided, those tables are the focal points (and must belong to `database-id`).

## Response `2XX`

Successful response

- MetabaseEnterpriseErdImplErdResponse
  - `edges` MetabaseEnterpriseErdImplErdEdge[], required
    - `relationship` 'one-to-one' | 'many-to-one', required
    - `source_field_id` integer, required
    - `source_table_id` integer, required
    - `target_field_id` integer, required
    - `target_table_id` integer, required
  - `nodes` MetabaseEnterpriseErdImplErdNode[], required
    - `db_id` integer, required
    - `description` string, nullable
    - `display_name` string, required
    - `fields` MetabaseEnterpriseErdImplErdField[], required
      - `base_type` string, nullable
      - `database_type` string, required
      - `display_name` string, required
      - `effective_type` string, nullable
      - `fk_target_field_id` integer, nullable
      - `fk_target_table_id` integer, nullable
      - `id` integer, required
      - `name` string, required
      - `semantic_type` string, nullable
    - `name` string, required
    - `owner` MetabaseEnterpriseErdImplErdOwner, nullable
      - `email` string, required
      - `first_name` string, nullable
      - `id` integer
      - `last_name` string, nullable
    - `schema` string, nullable
    - `table_id` integer, required
    - `visibility_type` string, nullable

## Other responses

- `4XX`: Client error response
- `5XX`: Server error response

## Changes

- **2026-11-04** `2e178f5a7934`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/metabase/apis/metabase-api/changes/api/ee/erd/get.md)

---

[API](https://skmtc.dev/metabase/apis/metabase-api.md) - [All operations](https://skmtc.dev/metabase/apis/metabase-api/llms.txt) - [OpenAPI document](https://skmtc.dev/metabase/apis/metabase-api/revisions/2e178f5a7934?raw)