---
title: "GET /base/{baseId}/erd"
method: GET
path: "/base/{baseId}/erd"
tags: ["base"]
---

# GET /base/{baseId}/erd

`GET /base/{baseId}/erd`

Get the erd of a base

## Path parameters

- `baseId` string, required

## Response `200`

Returns the erd of a base.

- object
  - `baseId` string, required
  - `nodes` object[], required
    - `id` string, required
    - `name` string, required
    - `icon` string
    - `crossBaseId` string
    - `crossBaseName` string
    - `fields` object[], required
      - `id` string, required — The id of the field.
      - `name` string, required — The name of the field. can not be duplicated in the table.
      - `type` 'singleLineText' | 'longText' | 'user' | 'attachment' | 'checkbox' | 'multipleSelect' | 'singleSelect' | 'date' | 'number' | 'rating' | 'formula' | 'rollup' | 'conditionalRollup' | 'link' | 'createdTime' | 'lastModifiedTime' | 'createdBy' | 'lastModifiedBy' | 'autoNumber' | 'button', required — The field types supported by teable.
      - `isLookup` boolean — Whether this field is lookup field. witch means cellValue and [fieldType] is looked up from the linked table.
      - `isConditionalLookup` boolean — Whether this lookup field applies a conditional filter when resolving linked records.
      - `isPrimary` boolean — Whether this field is primary field.
  - `edges` object[], required
    - `source` object, required
      - `tableId` string, required
      - `tableName` string, required
      - `fieldId` string, required
      - `fieldName` string, required
    - `target` object, required
      - `tableId` string, required
      - `tableName` string, required
      - `fieldId` string, required
      - `fieldName` string, required
    - `relationship` 'oneOne' | 'manyMany' | 'oneMany' | 'manyOne'
    - `isOneWay` boolean
    - `type` union, required
      - 'singleLineText' | 'longText' | 'user' | 'attachment' | 'checkbox' | 'multipleSelect' | 'singleSelect' | 'date' | 'number' | 'rating' | 'formula' | 'rollup' | 'conditionalRollup' | 'link' | 'createdTime' | 'lastModifiedTime' | 'createdBy' | 'lastModifiedBy' | 'autoNumber' | 'button'
      - 'lookup'

---

[API](https://skmtc.net/teable/apis/teable-app.md) · [All operations](https://skmtc.net/teable/apis/teable-app/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/teable/teable-app/revisions/7515f3b33d79/schema)