# Teable: English API

## API

### Getting Started

- [API Overview](https://help.teable.ai/en/api-doc/overview.md): Everything you need to start calling the Teable API: base URL, authentication, IDs, and common request patterns.
- [Access Token](https://help.teable.ai/en/api-doc/token.md): Personal access tokens are used for authentication and authorization.
- [OAuth App](https://help.teable.ai/en/api-doc/oauth.md): Build integrations that allow users to authorize access to their Teable data using OAuth 2.0.
- [Getting IDs](https://help.teable.ai/en/api-doc/get-id.md)
- [Error Codes](https://help.teable.ai/en/api-doc/error-code.md)

### Records

- [Get Records](https://help.teable.ai/en/api-doc/record/get.md)
- [Create Records](https://help.teable.ai/en/api-doc/record/create.md)
- [Update Record](https://help.teable.ai/en/api-doc/record/update.md)
- [Delete Records](https://help.teable.ai/en/api-doc/record/delete.md)
- [Upload Attachment](https://help.teable.ai/en/api-doc/record/upload-attachment.md): Upload local files or files via URL to the end of an attachment field in a specified record
- [Record Field Interface](https://help.teable.ai/en/api-doc/record/interface.md)

### API Reference

#### record

- [Get record](https://help.teable.ai/en/api-reference/record/get-record.md): Retrieve a single record by its ID with options to specify field projections and output format.
- [Delete record](https://help.teable.ai/en/api-reference/record/delete-record.md): Permanently delete a single record by its ID.
- [Update record](https://help.teable.ai/en/api-reference/record/update-record.md): Update a single record by its ID with support for field value typecast and record reordering.
- [List records](https://help.teable.ai/en/api-reference/record/list-records.md): Retrieve a list of records with support for filtering, sorting, grouping, and pagination. The response includes record data and optional group information.
- [Create records](https://help.teable.ai/en/api-reference/record/create-records.md): Create one or multiple records with support for field value typecast and custom record ordering.
- [Delete records](https://help.teable.ai/en/api-reference/record/delete-records.md): Permanently delete multiple records by their IDs in a single request.
- [Update multiple records](https://help.teable.ai/en/api-reference/record/update-multiple-records.md): Update multiple records in a single request with support for field value typecast and record reordering.
- [Duplicate record](https://help.teable.ai/en/api-reference/record/duplicate-record.md): Create a copy of an existing record with optional custom positioning in the view.
- [Get record history](https://help.teable.ai/en/api-reference/record/get-record-history.md): Retrieve the change history of a specific record, including field modifications and user information.
- [Get table records history](https://help.teable.ai/en/api-reference/record/get-table-records-history.md): Retrieve the change history of all records in a table, including field modifications and user information.
- [Upload attachment](https://help.teable.ai/en/api-reference/record/upload-attachment.md): Upload an attachment from a file or URL and append it to the cell
- [Insert attachments at anchor](https://help.teable.ai/en/api-reference/record/insert-attachments-at-anchor.md): Insert attachments after the anchor in the cell (append to end if anchor not found or not provided)
- [Get record status](https://help.teable.ai/en/api-reference/record/get-record-status.md): Retrieve the visibility and deletion status of a specific record.
- [Auto-fill a cell by AI](https://help.teable.ai/en/api-reference/record/auto-fill-a-cell-by-ai.md): Automatically fill a cell in a specific record and field
- [Button click](https://help.teable.ai/en/api-reference/record/button-click.md): Button click
- [Button reset](https://help.teable.ai/en/api-reference/record/button-reset.md): Button reset
- [Get table recordcollaborators](https://help.teable.ai/en/api-reference/record/get-table-recordcollaborators.md): Get collaborators of a record.
- [Submit form](https://help.teable.ai/en/api-reference/record/submit-form.md): Submit a record through a form view. This will trigger "When form submitted" automations.
- [Post table undo redoundo](https://help.teable.ai/en/api-reference/record/post-table-undo-redoundo.md): Undo the last operation
- [Post table undo redoredo](https://help.teable.ai/en/api-reference/record/post-table-undo-redoredo.md): Redo the last operation

#### trash

- [Delete trash](https://help.teable.ai/en/api-reference/trash/delete-trash.md): Permanently delete a trash item by trashId
- [Get trash](https://help.teable.ai/en/api-reference/trash/get-trash.md): Get trash list for spaces or bases
- [Get trashitems](https://help.teable.ai/en/api-reference/trash/get-trashitems.md): Get trash items for base or table

#### space

- [Get space list](https://help.teable.ai/en/api-reference/space/get-space-list.md): Get space list by query
- [Post space](https://help.teable.ai/en/api-reference/space/post-space.md): Create a space
- [Get space](https://help.teable.ai/en/api-reference/space/get-space.md): Get a space by spaceId
- [Delete space](https://help.teable.ai/en/api-reference/space/delete-space.md): Delete a space by spaceId
- [Patch space](https://help.teable.ai/en/api-reference/space/patch-space.md): Update a space info
- [Get space invitationlink](https://help.teable.ai/en/api-reference/space/get-space-invitationlink.md): List a invitation link to your
- [Post space invitationlink](https://help.teable.ai/en/api-reference/space/post-space-invitationlink.md): Create a invitation link to your
- [Delete space invitationlink](https://help.teable.ai/en/api-reference/space/delete-space-invitationlink.md): Delete a invitation link to your
- [Patch space invitationlink](https://help.teable.ai/en/api-reference/space/patch-space-invitationlink.md): Update a invitation link to your
- [Post space invitationemail](https://help.teable.ai/en/api-reference/space/post-space-invitationemail.md): Send invitations by e-mail
- [Get space collaborators](https://help.teable.ai/en/api-reference/space/get-space-collaborators.md): List a space collaborator
- [Delete space collaborators](https://help.teable.ai/en/api-reference/space/delete-space-collaborators.md): Delete a collaborator
- [Patch space collaborators](https://help.teable.ai/en/api-reference/space/patch-space-collaborators.md): Update a space collaborator
- [Post space collaborator](https://help.teable.ai/en/api-reference/space/post-space-collaborator.md): Add a collaborator to a space
- [Delete space permanent](https://help.teable.ai/en/api-reference/space/delete-space-permanent.md): Permanently delete a space by spaceId
- [Get space integration](https://help.teable.ai/en/api-reference/space/get-space-integration.md): Get integration list by query
- [Post space integration](https://help.teable.ai/en/api-reference/space/post-space-integration.md): Create a integration to a space
- [Delete space integration](https://help.teable.ai/en/api-reference/space/delete-space-integration.md): Delete a integration by integrationId
- [Patch space integration](https://help.teable.ai/en/api-reference/space/patch-space-integration.md): Update a integration to a space
- [Get space search](https://help.teable.ai/en/api-reference/space/get-space-search.md): Search bases and nodes within a space
- [Post trashrestore](https://help.teable.ai/en/api-reference/space/post-trashrestore.md): restore a space, base, table, etc.
- [Get space authentication](https://help.teable.ai/en/api-reference/space/get-space-authentication.md): Get a space authentication
- [Put space authentication](https://help.teable.ai/en/api-reference/space/put-space-authentication.md): Update a space authentication
- [Delete space authentication](https://help.teable.ai/en/api-reference/space/delete-space-authentication.md): Delete a space authentication
- [Get space authentication 1](https://help.teable.ai/en/api-reference/space/get-space-authentication-1.md): Get a space authentication list
- [Post space authentication](https://help.teable.ai/en/api-reference/space/post-space-authentication.md): Create a space authentication
- [Get spaceauthenticationproviders](https://help.teable.ai/en/api-reference/space/get-spaceauthenticationproviders.md): Get space authentication providers
- [Get space domain verification](https://help.teable.ai/en/api-reference/space/get-space-domain-verification.md): Get a space domain verification list
- [Post space domain verification](https://help.teable.ai/en/api-reference/space/post-space-domain-verification.md): Create a space domain verification
- [Delete space domain verification](https://help.teable.ai/en/api-reference/space/delete-space-domain-verification.md): Delete a space domain verification
- [Post space domain verificationsend verification email](https://help.teable.ai/en/api-reference/space/post-space-domain-verificationsend-verification-email.md): Send space email verification

#### base

- [Post base](https://help.teable.ai/en/api-reference/base/post-base.md): Create a base
- [Get base](https://help.teable.ai/en/api-reference/base/get-base.md): Get a base by baseId
- [Delete base](https://help.teable.ai/en/api-reference/base/delete-base.md): Delete a base by baseId
- [Patch base](https://help.teable.ai/en/api-reference/base/patch-base.md): Update a base info
- [Put base order](https://help.teable.ai/en/api-reference/base/put-base-order.md): Update base order
- [Get baseaccessall](https://help.teable.ai/en/api-reference/base/get-baseaccessall.md): Get base list by query
- [Get base collaborators](https://help.teable.ai/en/api-reference/base/get-base-collaborators.md): List a base collaborator
- [Delete base collaborators](https://help.teable.ai/en/api-reference/base/delete-base-collaborators.md): Delete a base collaborators
- [Patch base collaborators](https://help.teable.ai/en/api-reference/base/patch-base-collaborators.md): Update a base collaborator
- [Post baseduplicate](https://help.teable.ai/en/api-reference/base/post-baseduplicate.md): duplicate a base
- [Create a base from template or apply a template to a base](https://help.teable.ai/en/api-reference/base/create-a-base-from-template-or-apply-a-template-to-a-base.md): Create a base from template or apply a template to a base
- [Get base permission](https://help.teable.ai/en/api-reference/base/get-base-permission.md): Get a base permission
- [Get base invitationlink](https://help.teable.ai/en/api-reference/base/get-base-invitationlink.md): List a invitation link to your
- [Post base invitationlink](https://help.teable.ai/en/api-reference/base/post-base-invitationlink.md): Create a invitation link to your
- [Delete base invitationlink](https://help.teable.ai/en/api-reference/base/delete-base-invitationlink.md): Delete a invitation link to your
- [Patch base invitationlink](https://help.teable.ai/en/api-reference/base/patch-base-invitationlink.md): Update a invitation link to your
- [Post base invitationemail](https://help.teable.ai/en/api-reference/base/post-base-invitationemail.md): Send invitations by e-mail
- [Get baseshared base](https://help.teable.ai/en/api-reference/base/get-baseshared-base.md)
- [Delete base permanent](https://help.teable.ai/en/api-reference/base/delete-base-permanent.md): Permanently delete a base by baseId
- [Post base collaborator](https://help.teable.ai/en/api-reference/base/post-base-collaborator.md): Add a collaborator to a base
- [Get base collaborator user list](https://help.teable.ai/en/api-reference/base/get-base-collaborator-user-list.md): Get base collaborator user list
- [Get base export](https://help.teable.ai/en/api-reference/base/get-base-export.md): export a base by baseId
- [publish or unpublish a base](https://help.teable.ai/en/api-reference/base/publish-or-unpublish-a-base.md): publish or unpublish a base
- [import a base](https://help.teable.ai/en/api-reference/base/import-a-base.md): import a base
- [import a base with SSE progress events](https://help.teable.ai/en/api-reference/base/import-a-base-with-sse-progress-events.md): import a base with SSE progress stream
- [move a base to another space](https://help.teable.ai/en/api-reference/base/move-a-base-to-another-space.md): move a base to another space
- [Get base erd](https://help.teable.ai/en/api-reference/base/get-base-erd.md): Get the erd of a base
- [Get space base](https://help.teable.ai/en/api-reference/base/get-space-base.md): Get base list by query
- [Delete trashreset items](https://help.teable.ai/en/api-reference/base/delete-trashreset-items.md): Reset trash items for a base or table
- [Execute SQL query](https://help.teable.ai/en/api-reference/base/execute-sql-query.md): Execute SQL query on a base
- [Sign attachment URLs](https://help.teable.ai/en/api-reference/base/sign-attachment-urls.md): Generate signed URLs for attachment files

#### view

- [Put table view order](https://help.teable.ai/en/api-reference/view/put-table-view-order.md): Update view order
- [Get table view filter link records](https://help.teable.ai/en/api-reference/view/get-table-view-filter-link-records.md): Getting associated records for a view filter configuration.
- [Get view list](https://help.teable.ai/en/api-reference/view/get-view-list.md): Get view list
- [Post table view](https://help.teable.ai/en/api-reference/view/post-table-view.md): Create a view
- [Get table view](https://help.teable.ai/en/api-reference/view/get-table-view.md): Get a view
- [Delete table view](https://help.teable.ai/en/api-reference/view/delete-table-view.md): Delete a view
- [Put table view manual sort](https://help.teable.ai/en/api-reference/view/put-table-view-manual-sort.md): Update view raw order
- [Put table view column meta](https://help.teable.ai/en/api-reference/view/put-table-view-column-meta.md): Update view column meta
- [Put table view filter](https://help.teable.ai/en/api-reference/view/put-table-view-filter.md): Update view filter
- [Put table view sort](https://help.teable.ai/en/api-reference/view/put-table-view-sort.md): Update view sort condition
- [Put table view group](https://help.teable.ai/en/api-reference/view/put-table-view-group.md): Update view group condition
- [Patch table view options](https://help.teable.ai/en/api-reference/view/patch-table-view-options.md): Update view option
- [Put table view record order](https://help.teable.ai/en/api-reference/view/put-table-view-record-order.md): Update record order in view
- [Put table view name](https://help.teable.ai/en/api-reference/view/put-table-view-name.md): Update view name
- [Put table view description](https://help.teable.ai/en/api-reference/view/put-table-view-description.md): Update view description
- [Put table view share meta](https://help.teable.ai/en/api-reference/view/put-table-view-share-meta.md): Update view share meta
- [Post table view refresh share id](https://help.teable.ai/en/api-reference/view/post-table-view-refresh-share-id.md): Refresh view share id
- [Post table view disable share](https://help.teable.ai/en/api-reference/view/post-table-view-disable-share.md): Disable view share
- [Post table view enable share](https://help.teable.ai/en/api-reference/view/post-table-view-enable-share.md): Enable view share
- [Post table viewplugin](https://help.teable.ai/en/api-reference/view/post-table-viewplugin.md): Install a plugin to a view
- [Patch table view plugin](https://help.teable.ai/en/api-reference/view/patch-table-view-plugin.md): Update storage of a plugin in a view
- [Get table view plugin](https://help.teable.ai/en/api-reference/view/get-table-view-plugin.md): Get a view install plugin by id
- [Put table view locked](https://help.teable.ai/en/api-reference/view/put-table-view-locked.md): Update the locked status of the view
- [Post table view duplicate](https://help.teable.ai/en/api-reference/view/post-table-view-duplicate.md): Duplicate a view

#### dashboard

- [Get base dashboard](https://help.teable.ai/en/api-reference/dashboard/get-base-dashboard.md): Get a list of dashboards in base
- [Post base dashboard](https://help.teable.ai/en/api-reference/dashboard/post-base-dashboard.md): Create a new dashboard
- [Get base dashboard 1](https://help.teable.ai/en/api-reference/dashboard/get-base-dashboard-1.md): Get a dashboard by id
- [Delete base dashboard](https://help.teable.ai/en/api-reference/dashboard/delete-base-dashboard.md): Delete a dashboard by id
- [Patch base dashboard rename](https://help.teable.ai/en/api-reference/dashboard/patch-base-dashboard-rename.md): Rename a dashboard by id
- [Patch base dashboard layout](https://help.teable.ai/en/api-reference/dashboard/patch-base-dashboard-layout.md): Update a dashboard layout by id
- [Post base dashboard plugin](https://help.teable.ai/en/api-reference/dashboard/post-base-dashboard-plugin.md): Install a plugin to a dashboard
- [Get base dashboard plugin](https://help.teable.ai/en/api-reference/dashboard/get-base-dashboard-plugin.md): Get a dashboard install plugin by id
- [Delete base dashboard plugin](https://help.teable.ai/en/api-reference/dashboard/delete-base-dashboard-plugin.md): Remove a plugin from a dashboard
- [Patch base dashboard plugin rename](https://help.teable.ai/en/api-reference/dashboard/patch-base-dashboard-plugin-rename.md): Rename a plugin in a dashboard
- [Patch base dashboard plugin update storage](https://help.teable.ai/en/api-reference/dashboard/patch-base-dashboard-plugin-update-storage.md): Update storage of a plugin in a dashboard
- [Duplicate a dashboard](https://help.teable.ai/en/api-reference/dashboard/duplicate-a-dashboard.md): Duplicate a dashboard
- [Duplicate a dashboard installed plugin](https://help.teable.ai/en/api-reference/dashboard/duplicate-a-dashboard-installed-plugin.md): Duplicate a dashboard installed plugin

#### plugin

- [Get plugin](https://help.teable.ai/en/api-reference/plugin/get-plugin.md): Get plugins
- [Post plugin](https://help.teable.ai/en/api-reference/plugin/post-plugin.md): Create a plugin
- [Put plugin](https://help.teable.ai/en/api-reference/plugin/put-plugin.md): Update a plugin
- [Delete plugin](https://help.teable.ai/en/api-reference/plugin/delete-plugin.md): Delete a plugin
- [Post plugin regenerate secret](https://help.teable.ai/en/api-reference/plugin/post-plugin-regenerate-secret.md): Regenerate a plugin secret
- [Get plugin 1](https://help.teable.ai/en/api-reference/plugin/get-plugin-1.md): Get a plugin
- [Get plugincenterlist](https://help.teable.ai/en/api-reference/plugin/get-plugincenterlist.md): Get a list of plugins center
- [Patch plugin submit](https://help.teable.ai/en/api-reference/plugin/patch-plugin-submit.md): Submit a plugin
- [Get plugin token](https://help.teable.ai/en/api-reference/plugin/get-plugin-token.md): Get a token
- [Post plugin refreshtoken](https://help.teable.ai/en/api-reference/plugin/post-plugin-refreshtoken.md): Refresh a token
- [Post plugin authcode](https://help.teable.ai/en/api-reference/plugin/post-plugin-authcode.md): Get an auth code
- [Patch plugin unpublish](https://help.teable.ai/en/api-reference/plugin/patch-plugin-unpublish.md)
- [Get pluginchart dashboard query](https://help.teable.ai/en/api-reference/plugin/get-pluginchart-dashboard-query.md): Get a dashboard install plugin query by id
- [Get pluginchart plugin panel query](https://help.teable.ai/en/api-reference/plugin/get-pluginchart-plugin-panel-query.md): Get a plugin panel install plugin query by id

#### template

- [Post templatecreate](https://help.teable.ai/en/api-reference/template/post-templatecreate.md): create a template
- [get template detail by templateId](https://help.teable.ai/en/api-reference/template/get-template-detail-by-templateid.md): get template detail by templateId
- [Delete template](https://help.teable.ai/en/api-reference/template/delete-template.md): delete a template
- [Patch template](https://help.teable.ai/en/api-reference/template/patch-template.md): update a template
- [Get template](https://help.teable.ai/en/api-reference/template/get-template.md): get template list
- [Get templatepublished](https://help.teable.ai/en/api-reference/template/get-templatepublished.md): get published template list
- [Post template snapshot](https://help.teable.ai/en/api-reference/template/post-template-snapshot.md): create a template snapshot
- [Post templatecategorycreate](https://help.teable.ai/en/api-reference/template/post-templatecategorycreate.md): create a template category
- [Get templatecategorylist](https://help.teable.ai/en/api-reference/template/get-templatecategorylist.md): get template category list
- [Delete templatecategory](https://help.teable.ai/en/api-reference/template/delete-templatecategory.md): delete a template category
- [Patch templatecategory](https://help.teable.ai/en/api-reference/template/patch-templatecategory.md): update a template category name
- [Put templatecategory order](https://help.teable.ai/en/api-reference/template/put-templatecategory-order.md): Update template category order
- [Patch template pin top](https://help.teable.ai/en/api-reference/template/patch-template-pin-top.md): pin top a template
- [Put template order](https://help.teable.ai/en/api-reference/template/put-template-order.md): Update template order
- [get template by baseId](https://help.teable.ai/en/api-reference/template/get-template-by-baseid.md): get template by baseId
- [Delete templateunpublish](https://help.teable.ai/en/api-reference/template/delete-templateunpublish.md): unpublish a template
- [Increment template visit count](https://help.teable.ai/en/api-reference/template/increment-template-visit-count.md): Increment template visit count
- [Get template permalink redirect URL](https://help.teable.ai/en/api-reference/template/get-template-permalink-redirect-url.md): Get template redirect URL for permalink

#### attachments

- [Post attachmentsnotify](https://help.teable.ai/en/api-reference/attachments/post-attachmentsnotify.md): Get Attachment information
- [Get attachments](https://help.teable.ai/en/api-reference/attachments/get-attachments.md): Upload attachment
- [Post attachmentssignature](https://help.teable.ai/en/api-reference/attachments/post-attachmentssignature.md): Retrieve upload signature.
- [Post attachmentsupload](https://help.teable.ai/en/api-reference/attachments/post-attachmentsupload.md): Upload attachment

#### mail

- [Post mail sendertest transport config](https://help.teable.ai/en/api-reference/mail/post-mail-sendertest-transport-config.md): Test mail transporter

#### admin

- [Get adminsetting](https://help.teable.ai/en/api-reference/admin/get-adminsetting.md): Get the instance settings
- [Patch adminsetting](https://help.teable.ai/en/api-reference/admin/patch-adminsetting.md): Get the instance settings
- [Get adminsettingpublic](https://help.teable.ai/en/api-reference/admin/get-adminsettingpublic.md): Get the public instance settings
- [Patch adminsettinglogo](https://help.teable.ai/en/api-reference/admin/patch-adminsettinglogo.md): Upload logo
- [Post adminsettingtest llm](https://help.teable.ai/en/api-reference/admin/post-adminsettingtest-llm.md): Test LLM provider configuration
- [Post adminsettingbatch test llm](https://help.teable.ai/en/api-reference/admin/post-adminsettingbatch-test-llm.md): Batch test all configured LLM models to verify compatibility with AI field features
- [Post adminsettingtest api key](https://help.teable.ai/en/api-reference/admin/post-adminsettingtest-api-key.md): Test API key validity for AI Gateway or v0, optionally test attachment transfer modes
- [Get adminsettingtest public access](https://help.teable.ai/en/api-reference/admin/get-adminsettingtest-public-access.md): Test if this Teable instance is publicly accessible from the internet
- [Put adminsettingset mail transport config](https://help.teable.ai/en/api-reference/admin/put-adminsettingset-mail-transport-config.md): Set mail transporter
- [Get adminsettingai key stats](https://help.teable.ai/en/api-reference/admin/get-adminsettingai-key-stats.md): Get per-key usage statistics for AI Gateway API keys
- [Patch adminplugin publish](https://help.teable.ai/en/api-reference/admin/patch-adminplugin-publish.md): Publish a plugin
- [Patch adminplugin unpublish](https://help.teable.ai/en/api-reference/admin/patch-adminplugin-unpublish.md): Admin unpublish a plugin
- [Get adminenterprise licensestatus](https://help.teable.ai/en/api-reference/admin/get-adminenterprise-licensestatus.md): Get enterprise license expiration status
- [Delete adminuser](https://help.teable.ai/en/api-reference/admin/delete-adminuser.md): Delete a user by user ID for admin
- [Patch adminuser](https://help.teable.ai/en/api-reference/admin/patch-adminuser.md): Update a user info
- [Get adminuser](https://help.teable.ai/en/api-reference/admin/get-adminuser.md): Get paginated users for the instance
- [Delete adminuser permanent delete](https://help.teable.ai/en/api-reference/admin/delete-adminuser-permanent-delete.md): Permanent delete a user by user ID for admin
- [Post adminuser restore delete](https://help.teable.ai/en/api-reference/admin/post-adminuser-restore-delete.md): Restore a deleted user
- [Patch adminuser admin](https://help.teable.ai/en/api-reference/admin/patch-adminuser-admin.md): Set or unset admin privilege for a user
- [Delete adminspace](https://help.teable.ai/en/api-reference/admin/delete-adminspace.md): Delete a space by space ID for admin
- [Patch adminspace](https://help.teable.ai/en/api-reference/admin/patch-adminspace.md): update enterprise space information
- [Get adminspace](https://help.teable.ai/en/api-reference/admin/get-adminspace.md): Get paginated spaces for the instance
- [Get adminorganization](https://help.teable.ai/en/api-reference/admin/get-adminorganization.md): Get paginated organizations for the instance
- [Post adminorganization](https://help.teable.ai/en/api-reference/admin/post-adminorganization.md): Create a new organization
- [Delete adminorganization](https://help.teable.ai/en/api-reference/admin/delete-adminorganization.md): Delete an organization by organization ID for admin
- [Get adminorganization admin](https://help.teable.ai/en/api-reference/admin/get-adminorganization-admin.md): Get organization admin users
- [Put adminorganization admin](https://help.teable.ai/en/api-reference/admin/put-adminorganization-admin.md): Update organization admin status for a user
- [Get adminenterprise license](https://help.teable.ai/en/api-reference/admin/get-adminenterprise-license.md): Get enterprise license information
- [Post adminenterprise license](https://help.teable.ai/en/api-reference/admin/post-adminenterprise-license.md): Create a enterprise license
- [Patch adminenterprise license](https://help.teable.ai/en/api-reference/admin/patch-adminenterprise-license.md): Update a enterprise license by license ID
- [Get adminaudit logs](https://help.teable.ai/en/api-reference/admin/get-adminaudit-logs.md): Get audit logs with filtering and pagination
- [Get adminobservabilityworkflowsummary](https://help.teable.ai/en/api-reference/admin/get-adminobservabilityworkflowsummary.md): Retrieves a summary of workflow observability
- [Get adminobservabilityworkflow](https://help.teable.ai/en/api-reference/admin/get-adminobservabilityworkflow.md): get observability workflow list
- [Post adminobservabilityworkflow deactivate](https://help.teable.ai/en/api-reference/admin/post-adminobservabilityworkflow-deactivate.md): Deactivate a workflow observability
- [Delete adminobservabilityworkflow](https://help.teable.ai/en/api-reference/admin/delete-adminobservabilityworkflow.md): Delete a workflow observability
- [Get adminobservabilityworkflow run history](https://help.teable.ai/en/api-reference/admin/get-adminobservabilityworkflow-run-history.md): get workflow run history
- [Get admin reward overview by spaces](https://help.teable.ai/en/api-reference/admin/get-admin-reward-overview-by-spaces.md): Get aggregated reward statistics grouped by space for admin management. Returns pending, approved, consumed, available and expiring amounts per space.
- [Get admin reward list](https://help.teable.ai/en/api-reference/admin/get-admin-reward-list.md): Get paginated and filtered list of reward for admin management. Supports filtering by space, status, platform, verification result, and search.
- [Get all spaces with reward records](https://help.teable.ai/en/api-reference/admin/get-all-spaces-with-reward-records.md): Get a list of all spaces that have reward records for admin filtering
- [Get admin reward detail](https://help.teable.ai/en/api-reference/admin/get-admin-reward-detail.md): Get detailed information of a specific reward including full metadata
- [Export admin reward list as CSV](https://help.teable.ai/en/api-reference/admin/export-admin-reward-list-as-csv.md): Export all reward records for a specific space as CSV file. Supports filtering by date range.

#### field

- [List fields](https://help.teable.ai/en/api-reference/field/list-fields.md): Retrieve a list of fields in a table with optional filtering
- [Create field](https://help.teable.ai/en/api-reference/field/create-field.md): Create a new field in the specified table with the given configuration
- [Delete multiple fields](https://help.teable.ai/en/api-reference/field/delete-multiple-fields.md): Permanently remove multiple fields from the specified table
- [Get a field](https://help.teable.ai/en/api-reference/field/get-a-field.md): Retrieve detailed information about a specific field by its ID
- [Delete field](https://help.teable.ai/en/api-reference/field/delete-field.md): Permanently remove a field from the specified table
- [Update field](https://help.teable.ai/en/api-reference/field/update-field.md): Update common properties of a field (name, description, dbFieldName). For other property changes, use the convert field API
- [Convert field type](https://help.teable.ai/en/api-reference/field/convert-field-type.md): Convert field to a different type with automatic type casting and symmetric field handling
- [Get linked records for filter](https://help.teable.ai/en/api-reference/field/get-linked-records-for-filter.md): Retrieve associated records that match the view filter configuration for a linked field
- [Auto-fill a field by AI](https://help.teable.ai/en/api-reference/field/auto-fill-a-field-by-ai.md): Automatically generate suggestions for filling a specific field
- [Stop auto-fill a field by AI](https://help.teable.ai/en/api-reference/field/stop-auto-fill-a-field-by-ai.md): Stop auto-fill a field by AI
- [Duplicate field](https://help.teable.ai/en/api-reference/field/duplicate-field.md): Duplicate field
- [Get table fielddelete references](https://help.teable.ai/en/api-reference/field/get-table-fielddelete-references.md): Get resources that reference the given fields (for delete impact analysis)

#### aggregation

- [Get aggregated statistics](https://help.teable.ai/en/api-reference/aggregation/get-aggregated-statistics.md): Returns statistical aggregations of table data based on specified functions and grouping criteria
- [Get total row count](https://help.teable.ai/en/api-reference/aggregation/get-total-row-count.md): Returns the total number of rows in a view based on applied filters and criteria
- [Get group points](https://help.teable.ai/en/api-reference/aggregation/get-group-points.md): Returns the distribution and count of records across different group points in the view
- [Get daily calendar data](https://help.teable.ai/en/api-reference/aggregation/get-daily-calendar-data.md): Returns records and count distribution across dates based on specified date range and fields
- [Get total count of search](https://help.teable.ai/en/api-reference/aggregation/get-total-count-of-search.md): Returns the total count of records matching the specified search criteria and filters
- [Get record indices for search](https://help.teable.ai/en/api-reference/aggregation/get-record-indices-for-search.md): Returns the indices and record IDs of records matching the search criteria
- [Get task status collection](https://help.teable.ai/en/api-reference/aggregation/get-task-status-collection.md): Returns records and count distribution across task status based on specified date range and fields
- [Get record index](https://help.teable.ai/en/api-reference/aggregation/get-record-index.md): Returns the 0-based row index of a specific record in the current query context (respecting view filters, sort order, link filters)

#### table

- [Create table](https://help.teable.ai/en/api-reference/table/create-table.md): Create a new table in the specified base with customizable fields, views, and initial records. Default configurations will be applied if not specified.
- [Get table details](https://help.teable.ai/en/api-reference/table/get-table-details.md): Retrieve detailed information about a specific table, including its schema, name, and configuration.
- [Delete table](https://help.teable.ai/en/api-reference/table/delete-table.md): Move a table to trash. The table can be restored within the retention period.
- [List tables](https://help.teable.ai/en/api-reference/table/list-tables.md): Retrieve a list of all tables in the specified base, including their basic information and configurations.
- [Permanently delete table](https://help.teable.ai/en/api-reference/table/permanently-delete-table.md): Permanently delete a table and all its data. This action cannot be undone.
- [Update table name](https://help.teable.ai/en/api-reference/table/update-table-name.md): Update the display name of a table. This will not affect the underlying database table name.
- [Update table tcon](https://help.teable.ai/en/api-reference/table/update-table-tcon.md): Update the emoji icon of a table. The icon must be a valid emoji character.
- [Update table order](https://help.teable.ai/en/api-reference/table/update-table-order.md): Update the display order of a table in the base. This affects the order in which tables are shown in the UI.
- [Update table description](https://help.teable.ai/en/api-reference/table/update-table-description.md): Update or remove the description of a table. Set to null to remove the description.
- [Update db table name](https://help.teable.ai/en/api-reference/table/update-db-table-name.md): Update the physical database table name. Must be 1-63 characters, start with letter or underscore, contain only letters, numbers and underscore, and be unique within the base.
- [Get default view id](https://help.teable.ai/en/api-reference/table/get-default-view-id.md): Get default view id
- [Get table permissions](https://help.teable.ai/en/api-reference/table/get-table-permissions.md): Retrieve the current user's permissions for a table, including access rights for table operations, views, records, and fields.
- [Toggle table index](https://help.teable.ai/en/api-reference/table/toggle-table-index.md): Toggle table index
- [Get activated index](https://help.teable.ai/en/api-reference/table/get-activated-index.md): Get the activated index of a table
- [Get abnormal indexes](https://help.teable.ai/en/api-reference/table/get-abnormal-indexes.md): Retrieve a list of abnormal database indexes for a specific table by index type. This helps identify potential performance or maintenance issues.
- [Repair table index](https://help.teable.ai/en/api-reference/table/repair-table-index.md): Repair table index
- [Duplicate a table](https://help.teable.ai/en/api-reference/table/duplicate-a-table.md): Duplicate a table

#### selection

- [Get ids from range](https://help.teable.ai/en/api-reference/selection/get-ids-from-range.md): Retrieve record and field identifiers based on the selected range coordinates in a table
- [Clear selected range content](https://help.teable.ai/en/api-reference/selection/clear-selected-range-content.md): Remove all content from the selected table range
- [Copy selected table content](https://help.teable.ai/en/api-reference/selection/copy-selected-table-content.md): Copy content from selected table ranges including headers if specified
- [Paste content into selected range](https://help.teable.ai/en/api-reference/selection/paste-content-into-selected-range.md): Apply paste operation to insert content into the selected table range
- [Delete selected range data](https://help.teable.ai/en/api-reference/selection/delete-selected-range-data.md): Delete records or fields within the selected table range
- [Preview paste operation results](https://help.teable.ai/en/api-reference/selection/preview-paste-operation-results.md): Preview the results of a paste operation without applying changes to the table

#### plan

- [Get table field plan](https://help.teable.ai/en/api-reference/plan/get-table-field-plan.md): Generate calculation plan for the field
- [Put table field plan](https://help.teable.ai/en/api-reference/plan/put-table-field-plan.md): Generate calculation plan for converting the field
- [Delete table field plan](https://help.teable.ai/en/api-reference/plan/delete-table-field-plan.md): Generate calculation plan for deleting the field
- [Post table fieldplan](https://help.teable.ai/en/api-reference/plan/post-table-fieldplan.md): Generate calculation plan for creating the field

#### user

- [Patch username](https://help.teable.ai/en/api-reference/user/patch-username.md): Update user name
- [Patch useravatar](https://help.teable.ai/en/api-reference/user/patch-useravatar.md): Update user avatar
- [Patch usernotify meta](https://help.teable.ai/en/api-reference/user/patch-usernotify-meta.md): Update user notification meta
- [Patch userlang](https://help.teable.ai/en/api-reference/user/patch-userlang.md): Update user language
- [Get userlast visit](https://help.teable.ai/en/api-reference/user/get-userlast-visit.md): Get user last visited resource
- [Post userlast visit](https://help.teable.ai/en/api-reference/user/post-userlast-visit.md): Update or create user last visit record
- [Get userlast visitmap](https://help.teable.ai/en/api-reference/user/get-userlast-visitmap.md): Get user last visited resource map
- [Get userlast visitlist base](https://help.teable.ai/en/api-reference/user/get-userlast-visitlist-base.md)
- [Get userlast visitbase node](https://help.teable.ai/en/api-reference/user/get-userlast-visitbase-node.md): Get user last visited base node

#### auth

- [Get authuserme](https://help.teable.ai/en/api-reference/auth/get-authuserme.md): Get user information
- [Post authsignin](https://help.teable.ai/en/api-reference/auth/post-authsignin.md): Sign in
- [Post authsignout](https://help.teable.ai/en/api-reference/auth/post-authsignout.md): Sign out
- [Post authsignup](https://help.teable.ai/en/api-reference/auth/post-authsignup.md): Sign up
- [Patch authchange password](https://help.teable.ai/en/api-reference/auth/patch-authchange-password.md): Change password
- [Post authsend reset password email](https://help.teable.ai/en/api-reference/auth/post-authsend-reset-password-email.md): Send reset password email
- [Post authreset password](https://help.teable.ai/en/api-reference/auth/post-authreset-password.md): Reset password
- [Post authadd password](https://help.teable.ai/en/api-reference/auth/post-authadd-password.md): Add password
- [Get authuser](https://help.teable.ai/en/api-reference/auth/get-authuser.md): Get user information via access token
- [Delete authuser](https://help.teable.ai/en/api-reference/auth/delete-authuser.md): Delete user
- [Post authsend signup verification code](https://help.teable.ai/en/api-reference/auth/post-authsend-signup-verification-code.md): Send signup verification code
- [Patch authchange email](https://help.teable.ai/en/api-reference/auth/patch-authchange-email.md): Change email
- [Post authsend change email code](https://help.teable.ai/en/api-reference/auth/post-authsend-change-email-code.md): Send change email code
- [Get authtemp token](https://help.teable.ai/en/api-reference/auth/get-authtemp-token.md): Get temp token
- [Post authinvite waitlist](https://help.teable.ai/en/api-reference/auth/post-authinvite-waitlist.md): Invite waitlist
- [Post authwaitlist invite code](https://help.teable.ai/en/api-reference/auth/post-authwaitlist-invite-code.md): Gen waitlist invite code
- [Post authjoin waitlist](https://help.teable.ai/en/api-reference/auth/post-authjoin-waitlist.md): Join waitlist
- [Get authwaitlist](https://help.teable.ai/en/api-reference/auth/get-authwaitlist.md): Get waitlist

#### db-connection

- [Get base connection](https://help.teable.ai/en/api-reference/db-connection/get-base-connection.md): Get db connection info
- [Post base connection](https://help.teable.ai/en/api-reference/db-connection/post-base-connection.md): Create a db connection url
- [Delete base connection](https://help.teable.ai/en/api-reference/db-connection/delete-base-connection.md): Delete a db connection

#### invitation

- [Post invitationlinkaccept](https://help.teable.ai/en/api-reference/invitation/post-invitationlinkaccept.md): Accept invitation link

#### share

- [Post share viewauth](https://help.teable.ai/en/api-reference/share/post-share-viewauth.md): share view auth password
- [Get share view](https://help.teable.ai/en/api-reference/share/get-share-view.md): get share view info
- [Get share viewaggregations](https://help.teable.ai/en/api-reference/share/get-share-viewaggregations.md): Get share view aggregations
- [Get share viewrow count](https://help.teable.ai/en/api-reference/share/get-share-viewrow-count.md): Get row count for the share view
- [Get share viewrecords](https://help.teable.ai/en/api-reference/share/get-share-viewrecords.md): Get records for the share view
- [Post share viewform submit](https://help.teable.ai/en/api-reference/share/post-share-viewform-submit.md): share form view submit new record
- [Get share viewcopy](https://help.teable.ai/en/api-reference/share/get-share-viewcopy.md): Copy operations in Share view
- [Get share viewgroup points](https://help.teable.ai/en/api-reference/share/get-share-viewgroup-points.md): Get group points for the share view
- [Get share viewlink records](https://help.teable.ai/en/api-reference/share/get-share-viewlink-records.md): In a view with a field selector, link the records list of the associated field selector to get the. Linking the desired ones inside the share view should fetch the ones that have already been selected.
- [Get share viewcollaborators](https://help.teable.ai/en/api-reference/share/get-share-viewcollaborators.md): View collaborators in a view with a user field selector.
- [Get share viewsearch count](https://help.teable.ai/en/api-reference/share/get-share-viewsearch-count.md): Get share view search result count with query
- [Get share viewsearch index](https://help.teable.ai/en/api-reference/share/get-share-viewsearch-index.md): Get share view record index with search query
- [Get share viewcalendar daily collection](https://help.teable.ai/en/api-reference/share/get-share-viewcalendar-daily-collection.md): Get calendar daily collection for the share view
- [Button click](https://help.teable.ai/en/api-reference/share/button-click.md): Button click

#### notification

- [Get notifications](https://help.teable.ai/en/api-reference/notification/get-notifications.md): List a user notification
- [Patch notifications status](https://help.teable.ai/en/api-reference/notification/patch-notifications-status.md): Patch notification status
- [Patch notificationsread all](https://help.teable.ai/en/api-reference/notification/patch-notificationsread-all.md): mark all notifications as read
- [Get notificationsunread count](https://help.teable.ai/en/api-reference/notification/get-notificationsunread-count.md): User notification unread count

#### access-token

- [Get access token](https://help.teable.ai/en/api-reference/access-token/get-access-token.md): List access token
- [Post access token](https://help.teable.ai/en/api-reference/access-token/post-access-token.md): Create access token
- [Post access token refresh](https://help.teable.ai/en/api-reference/access-token/post-access-token-refresh.md): Refresh access token
- [Get access token 1](https://help.teable.ai/en/api-reference/access-token/get-access-token-1.md): Get access token
- [Put access token](https://help.teable.ai/en/api-reference/access-token/put-access-token.md): Update access token
- [Delete access token](https://help.teable.ai/en/api-reference/access-token/delete-access-token.md): Delete access token

#### import

- [Get importanalyze](https://help.teable.ai/en/api-reference/import/get-importanalyze.md): Get a column info from analyze sheet
- [Post import](https://help.teable.ai/en/api-reference/import/post-import.md): create table from file
- [Patch import ](https://help.teable.ai/en/api-reference/import/patch-import-.md): import table inplace

#### export

- [Get export](https://help.teable.ai/en/api-reference/export/get-export.md): export csv from table

#### pin

- [Delete pin](https://help.teable.ai/en/api-reference/pin/delete-pin.md): Delete pin
- [Post pin](https://help.teable.ai/en/api-reference/pin/post-pin.md): Add pin
- [Get pinlist](https://help.teable.ai/en/api-reference/pin/get-pinlist.md): Get  pin list
- [Put pinorder](https://help.teable.ai/en/api-reference/pin/put-pinorder.md): Update  pin order

#### billing

- [Get space billingsubscriptionsummary](https://help.teable.ai/en/api-reference/billing/get-space-billingsubscriptionsummary.md): Retrieves a summary of subscription information for a space
- [Get billingsubscriptionsummary](https://help.teable.ai/en/api-reference/billing/get-billingsubscriptionsummary.md): Retrieves a summary of subscription information across all spaces
- [Get billingbase products](https://help.teable.ai/en/api-reference/billing/get-billingbase-products.md): Get base products list
- [Get billingadd on products](https://help.teable.ai/en/api-reference/billing/get-billingadd-on-products.md): Get add-on products list
- [Get space billingsubscription](https://help.teable.ai/en/api-reference/billing/get-space-billingsubscription.md): Get subscription detail by spaceId
- [Delete space billingsubscription](https://help.teable.ai/en/api-reference/billing/delete-space-billingsubscription.md): Cancel subscription for a space
- [Get space billing](https://help.teable.ai/en/api-reference/billing/get-space-billing.md): Get space billing details
- [Get space billinginvoicebase list](https://help.teable.ai/en/api-reference/billing/get-space-billinginvoicebase-list.md): Get paginated invoice list by spaceId
- [Get billingsubscriptionlicense](https://help.teable.ai/en/api-reference/billing/get-billingsubscriptionlicense.md): Get license details for the self-hosted related subscription
- [Get billingsubscriptionlicense 1](https://help.teable.ai/en/api-reference/billing/get-billingsubscriptionlicense-1.md): Get license list
- [Post billingsubscriptionlicensemanage billing](https://help.teable.ai/en/api-reference/billing/post-billingsubscriptionlicensemanage-billing.md): Manage billing
- [Get billingsubscriptionlicensemanage billingavailability](https://help.teable.ai/en/api-reference/billing/get-billingsubscriptionlicensemanage-billingavailability.md): Get manage billing portal availability
- [Post space billingsubscriptioncheckout](https://help.teable.ai/en/api-reference/billing/post-space-billingsubscriptioncheckout.md): Get checkout session url for a space
- [Post billingsubscriptionlicensecheckout](https://help.teable.ai/en/api-reference/billing/post-billingsubscriptionlicensecheckout.md): Get checkout session url for a self-hosted license
- [Get space billingsubscriptionplan](https://help.teable.ai/en/api-reference/billing/get-space-billingsubscriptionplan.md): Retrieves the plan subscription
- [Get billingall products](https://help.teable.ai/en/api-reference/billing/get-billingall-products.md): Get all products collection
- [Get space billingcredit summary](https://help.teable.ai/en/api-reference/billing/get-space-billingcredit-summary.md): Get space credit summary
- [Get space billingcredit detail](https://help.teable.ai/en/api-reference/billing/get-space-billingcredit-detail.md): Get space credit usage detail by month
- [Get space billingcredit history](https://help.teable.ai/en/api-reference/billing/get-space-billingcredit-history.md): Get space credit history list with cursor pagination
- [Get space billingmanage portal](https://help.teable.ai/en/api-reference/billing/get-space-billingmanage-portal.md): Get Stripe customer portal URL for managing billing details

#### usage

- [Get space usage](https://help.teable.ai/en/api-reference/usage/get-space-usage.md): Get usage information for the space
- [Get instanceusage](https://help.teable.ai/en/api-reference/usage/get-instanceusage.md): Get usage information for the instance
- [Get base usage](https://help.teable.ai/en/api-reference/usage/get-base-usage.md): Get usage information for the base

#### oauth

- [Get oauthclient](https://help.teable.ai/en/api-reference/oauth/get-oauthclient.md): Get the OAuth application
- [Put oauthclient](https://help.teable.ai/en/api-reference/oauth/put-oauthclient.md): Update an OAuth application
- [Delete oauthclient](https://help.teable.ai/en/api-reference/oauth/delete-oauthclient.md): Delete an OAuth application
- [Get oauthclient 1](https://help.teable.ai/en/api-reference/oauth/get-oauthclient-1.md): Get the list of OAuth applications
- [Post oauthclient](https://help.teable.ai/en/api-reference/oauth/post-oauthclient.md): Create a new OAuth application
- [Post oauthclient revoke token](https://help.teable.ai/en/api-reference/oauth/post-oauthclient-revoke-token.md)
- [Delete oauthclient secret](https://help.teable.ai/en/api-reference/oauth/delete-oauthclient-secret.md): Delete the OAuth secret
- [Post oauthclient secret](https://help.teable.ai/en/api-reference/oauth/post-oauthclient-secret.md): Generate a new OAuth secret
- [Get oauthdecision](https://help.teable.ai/en/api-reference/oauth/get-oauthdecision.md): Get the OAuth application
- [Post oauthclient revoke access](https://help.teable.ai/en/api-reference/oauth/post-oauthclient-revoke-access.md)
- [Get oauthclientauthorizedlist](https://help.teable.ai/en/api-reference/oauth/get-oauthclientauthorizedlist.md): Get the list of authorized applications

#### comment

- [Post comment  reaction](https://help.teable.ai/en/api-reference/comment/post-comment--reaction.md): create record comment reaction
- [Delete comment  reaction](https://help.teable.ai/en/api-reference/comment/delete-comment--reaction.md): delete record comment reaction
- [Get comment ](https://help.teable.ai/en/api-reference/comment/get-comment-.md): Get record comment detail
- [Delete comment ](https://help.teable.ai/en/api-reference/comment/delete-comment-.md): delete record comment
- [Patch comment ](https://help.teable.ai/en/api-reference/comment/patch-comment-.md): update record comment
- [Get comment list](https://help.teable.ai/en/api-reference/comment/get-comment-list.md): Get record comment list
- [Post comment create](https://help.teable.ai/en/api-reference/comment/post-comment-create.md): create record comment
- [Get comment subscribe](https://help.teable.ai/en/api-reference/comment/get-comment-subscribe.md): get record comment subscribe detail
- [Post comment subscribe](https://help.teable.ai/en/api-reference/comment/post-comment-subscribe.md): subscribe record comment's active
- [Delete comment subscribe](https://help.teable.ai/en/api-reference/comment/delete-comment-subscribe.md): unsubscribe record comment
- [Get comment attachment](https://help.teable.ai/en/api-reference/comment/get-comment-attachment.md): Get record comment attachment url
- [Get comment count](https://help.teable.ai/en/api-reference/comment/get-comment-count.md): Get record comment counts by query
- [Get comment count 1](https://help.teable.ai/en/api-reference/comment/get-comment-count-1.md): Get record comment count

#### organization

- [Get organizationme](https://help.teable.ai/en/api-reference/organization/get-organizationme.md): Get my organization
- [Get organizationdepartment](https://help.teable.ai/en/api-reference/organization/get-organizationdepartment.md)
- [Get organizationdepartment user](https://help.teable.ai/en/api-reference/organization/get-organizationdepartment-user.md)
- [Get organization](https://help.teable.ai/en/api-reference/organization/get-organization.md): Get organization
- [Put organization rename](https://help.teable.ai/en/api-reference/organization/put-organization-rename.md): Rename organization
- [Put organization update auto space](https://help.teable.ai/en/api-reference/organization/put-organization-update-auto-space.md): Update auto space
- [Get organization space](https://help.teable.ai/en/api-reference/organization/get-organization-space.md): Get organization space
- [Get organization setting](https://help.teable.ai/en/api-reference/organization/get-organization-setting.md): Get organization setting
- [Get organization users](https://help.teable.ai/en/api-reference/organization/get-organization-users.md): Get organization users
- [Post organization users](https://help.teable.ai/en/api-reference/organization/post-organization-users.md)
- [Post organization user](https://help.teable.ai/en/api-reference/organization/post-organization-user.md): Add organization user
- [Delete organization user](https://help.teable.ai/en/api-reference/organization/delete-organization-user.md): Delete organization user
- [Post organization user deactivate](https://help.teable.ai/en/api-reference/organization/post-organization-user-deactivate.md): Deactivate organization user
- [Post organization user activate](https://help.teable.ai/en/api-reference/organization/post-organization-user-activate.md): Activate organization user
- [Get organization user](https://help.teable.ai/en/api-reference/organization/get-organization-user.md)
- [Patch organization user](https://help.teable.ai/en/api-reference/organization/patch-organization-user.md): Update organization user
- [Get organization user exists](https://help.teable.ai/en/api-reference/organization/get-organization-user-exists.md)
- [Put organization department scope](https://help.teable.ai/en/api-reference/organization/put-organization-department-scope.md): Update department scope
- [Get organization department](https://help.teable.ai/en/api-reference/organization/get-organization-department.md)
- [Delete organization department](https://help.teable.ai/en/api-reference/organization/delete-organization-department.md)
- [Patch organization department rename](https://help.teable.ai/en/api-reference/organization/patch-organization-department-rename.md)
- [Patch organization department move](https://help.teable.ai/en/api-reference/organization/patch-organization-department-move.md)
- [Get organization department 1](https://help.teable.ai/en/api-reference/organization/get-organization-department-1.md)
- [Post organization department](https://help.teable.ai/en/api-reference/organization/post-organization-department.md)
- [Get organization department user](https://help.teable.ai/en/api-reference/organization/get-organization-department-user.md)
- [Post organization department user](https://help.teable.ai/en/api-reference/organization/post-organization-department-user.md)
- [Delete organization department user](https://help.teable.ai/en/api-reference/organization/delete-organization-department-user.md)
- [Patch organization department usermove](https://help.teable.ai/en/api-reference/organization/patch-organization-department-usermove.md)
- [Patch organization department userdepartment](https://help.teable.ai/en/api-reference/organization/patch-organization-department-userdepartment.md)
- [Get organization me](https://help.teable.ai/en/api-reference/organization/get-organization-me.md): Get organization me
- [Get instanceorganization](https://help.teable.ai/en/api-reference/organization/get-instanceorganization.md): Get instance organization, only for enterprise edition

#### ai

- [Post api aigenerate stream](https://help.teable.ai/en/api-reference/ai/post-api-aigenerate-stream.md): Generate ai stream
- [Get  aiconfig](https://help.teable.ai/en/api-reference/ai/get--aiconfig.md): Get the configuration of ai, including instance and space configuration
- [Get  aidisable ai actions](https://help.teable.ai/en/api-reference/ai/get--aidisable-ai-actions.md): Get the disable ai actions
- [Post api aigenerate](https://help.teable.ai/en/api-reference/ai/post-api-aigenerate.md): Generate AI text (non-streaming)

#### integrity

- [Get integritybase link check](https://help.teable.ai/en/api-reference/integrity/get-integritybase-link-check.md): Check integrity of link fields in a base
- [Post integritybase link fix](https://help.teable.ai/en/api-reference/integrity/post-integritybase-link-fix?tableid=.md): Fix integrity of link fields in a base

#### plugin-panel

- [Get table plugin panel](https://help.teable.ai/en/api-reference/plugin-panel/get-table-plugin-panel.md): Get a plugin panel
- [Delete table plugin panel](https://help.teable.ai/en/api-reference/plugin-panel/delete-table-plugin-panel.md): Delete a plugin panel
- [Get table plugin panel 1](https://help.teable.ai/en/api-reference/plugin-panel/get-table-plugin-panel-1.md): Get all plugin panels
- [Post table plugin panel](https://help.teable.ai/en/api-reference/plugin-panel/post-table-plugin-panel.md): Create a plugin panel
- [Patch table plugin panel rename](https://help.teable.ai/en/api-reference/plugin-panel/patch-table-plugin-panel-rename.md): Rename a plugin panel
- [Patch table plugin panel layout](https://help.teable.ai/en/api-reference/plugin-panel/patch-table-plugin-panel-layout.md): Update the layout of a plugin panel
- [Post table plugin panel install](https://help.teable.ai/en/api-reference/plugin-panel/post-table-plugin-panel-install.md): Install a plugin to a table plugin panel
- [Get table plugin panel plugin](https://help.teable.ai/en/api-reference/plugin-panel/get-table-plugin-panel-plugin.md): Get a plugin in plugin panel
- [Delete table plugin panel plugin](https://help.teable.ai/en/api-reference/plugin-panel/delete-table-plugin-panel-plugin.md): Remove a plugin from a plugin panel
- [Patch table plugin panel plugin rename](https://help.teable.ai/en/api-reference/plugin-panel/patch-table-plugin-panel-plugin-rename.md): Rename a plugin in a plugin panel
- [Patch table plugin panel plugin update storage](https://help.teable.ai/en/api-reference/plugin-panel/patch-table-plugin-panel-plugin-update-storage.md): Update storage of a plugin in a plugin panel
- [Duplicate a plugin panel](https://help.teable.ai/en/api-reference/plugin-panel/duplicate-a-plugin-panel.md): Duplicate a plugin panel
- [Duplicate a dashboard installed plugin](https://help.teable.ai/en/api-reference/plugin-panel/duplicate-a-dashboard-installed-plugin.md): Duplicate a dashboard installed plugin

#### plugin-context-menu

- [Get table plugin context menu](https://help.teable.ai/en/api-reference/plugin-context-menu/get-table-plugin-context-menu.md)
- [Delete table plugin context menu](https://help.teable.ai/en/api-reference/plugin-context-menu/delete-table-plugin-context-menu.md): Remove a plugin context menu
- [Post table plugin context menuinstall](https://help.teable.ai/en/api-reference/plugin-context-menu/post-table-plugin-context-menuinstall.md): Install a plugin context menu
- [Put table plugin context menu move](https://help.teable.ai/en/api-reference/plugin-context-menu/put-table-plugin-context-menu-move.md)
- [Patch table plugin context menu rename](https://help.teable.ai/en/api-reference/plugin-context-menu/patch-table-plugin-context-menu-rename.md): Rename a plugin context menu
- [Put table plugin context menu update storage](https://help.teable.ai/en/api-reference/plugin-context-menu/put-table-plugin-context-menu-update-storage.md)
- [Get table plugin context menu 1](https://help.teable.ai/en/api-reference/plugin-context-menu/get-table-plugin-context-menu-1.md)
- [Get table plugin context menu storage](https://help.teable.ai/en/api-reference/plugin-context-menu/get-table-plugin-context-menu-storage.md)

#### unsubscribe

- [Get unsubscribe](https://help.teable.ai/en/api-reference/unsubscribe/get-unsubscribe.md): Get unsubscribe information
- [Post unsubscribe](https://help.teable.ai/en/api-reference/unsubscribe/post-unsubscribe.md): Update subscription status
- [Get unsubscribelist](https://help.teable.ai/en/api-reference/unsubscribe/get-unsubscribelist.md): Get paginated unsubscribe list by baseId
- [Get unsubscribeexport list](https://help.teable.ai/en/api-reference/unsubscribe/get-unsubscribeexport-list.md): Export unsubscribe list
- [Post unsubscribeimport list](https://help.teable.ai/en/api-reference/unsubscribe/post-unsubscribeimport-list.md): Import unsubscribe list

#### base node

- [Get base node](https://help.teable.ai/en/api-reference/base-node/get-base-node.md): Get nodes for a base
- [Put base node](https://help.teable.ai/en/api-reference/base-node/put-base-node.md): Update a node for a base
- [Delete base node](https://help.teable.ai/en/api-reference/base-node/delete-base-node.md): Delete a node for a base
- [Get base nodetree](https://help.teable.ai/en/api-reference/base-node/get-base-nodetree.md): Get tree nodes for a base
- [Get base nodelist](https://help.teable.ai/en/api-reference/base-node/get-base-nodelist.md): Get list nodes of a base
- [Put base node move](https://help.teable.ai/en/api-reference/base-node/put-base-node-move.md): Move or reorder a node
- [Post base nodefolder](https://help.teable.ai/en/api-reference/base-node/post-base-nodefolder.md): Create a folder node in base
- [Post base node](https://help.teable.ai/en/api-reference/base-node/post-base-node.md): Create a hierarchical node for a base
- [Post base node duplicate](https://help.teable.ai/en/api-reference/base-node/post-base-node-duplicate.md): Duplicate a node for a base
- [Delete base node permanent](https://help.teable.ai/en/api-reference/base-node/delete-base-node-permanent.md): Permanent delete a node for a base
- [Delete base nodefolder](https://help.teable.ai/en/api-reference/base-node/delete-base-nodefolder.md): Delete a node folder and move its children to parent
- [Patch base nodefolder](https://help.teable.ai/en/api-reference/base-node/patch-base-nodefolder.md): Rename a node folder

#### base-share

- [Get base share](https://help.teable.ai/en/api-reference/base-share/get-base-share.md): Get all shared node IDs for a base
- [Post base share](https://help.teable.ai/en/api-reference/base-share/post-base-share.md): Create a base share link
- [Delete base share](https://help.teable.ai/en/api-reference/base-share/delete-base-share.md): Delete a base share link
- [Patch base share](https://help.teable.ai/en/api-reference/base-share/patch-base-share.md): Update a base share link
- [Post base share refresh](https://help.teable.ai/en/api-reference/base-share/post-base-share-refresh.md): Refresh/regenerate a base share link ID
- [Get share base](https://help.teable.ai/en/api-reference/base-share/get-share-base.md): Get shared base information
- [Get base sharenode](https://help.teable.ai/en/api-reference/base-share/get-base-sharenode.md): Get a base share by node ID
- [Post share baseauth](https://help.teable.ai/en/api-reference/base-share/post-share-baseauth.md): Authenticate with password to access shared base
- [Post share basecopy](https://help.teable.ai/en/api-reference/base-share/post-share-basecopy.md): Copy a shared base to a target space

#### user-integration

- [Get user integrations](https://help.teable.ai/en/api-reference/user-integration/get-user-integrations.md): Get user integration list
- [Delete user integrations](https://help.teable.ai/en/api-reference/user-integration/delete-user-integrations.md): Delete user integration
- [Put user integrations name](https://help.teable.ai/en/api-reference/user-integration/put-user-integrations-name.md): Update user integration name

#### automation

- [Get base workflow action](https://help.teable.ai/en/api-reference/automation/get-base-workflow-action.md): get a automation workflow action
- [Put base workflow action](https://help.teable.ai/en/api-reference/automation/put-base-workflow-action.md): update a automation workflow action
- [Delete base workflow action](https://help.teable.ai/en/api-reference/automation/delete-base-workflow-action.md): delete a automation workflow action
- [Post base workflow action](https://help.teable.ai/en/api-reference/automation/post-base-workflow-action.md): Create a automation workflow action
- [Post base workflow action duplicate](https://help.teable.ai/en/api-reference/automation/post-base-workflow-action-duplicate.md): duplicate a automation workflow action
- [Get base workflow action script input](https://help.teable.ai/en/api-reference/automation/get-base-workflow-action-script-input.md): Get script integrations for a workflow action
- [Get base workflow logic](https://help.teable.ai/en/api-reference/automation/get-base-workflow-logic.md): get a automation workflow logic
- [Put base workflow logic](https://help.teable.ai/en/api-reference/automation/put-base-workflow-logic.md): update a automation workflow logic
- [Delete base workflow logic](https://help.teable.ai/en/api-reference/automation/delete-base-workflow-logic.md): delete a automation workflow logic
- [Post base workflow logic](https://help.teable.ai/en/api-reference/automation/post-base-workflow-logic.md): Create a automation workflow logic
- [Get base workflow trigger](https://help.teable.ai/en/api-reference/automation/get-base-workflow-trigger.md): get a automation workflow trigger
- [Put base workflow trigger](https://help.teable.ai/en/api-reference/automation/put-base-workflow-trigger.md): update a automation workflow trigger
- [Post base workflow trigger](https://help.teable.ai/en/api-reference/automation/post-base-workflow-trigger.md): Create a automation workflow trigger
- [Post base workflow trigger generate webhook token](https://help.teable.ai/en/api-reference/automation/post-base-workflow-trigger-generate-webhook-token.md): Generate a new webhook token for the trigger
- [Get base workflow](https://help.teable.ai/en/api-reference/automation/get-base-workflow.md): get a automation workflow
- [Put base workflow](https://help.teable.ai/en/api-reference/automation/put-base-workflow.md): update a automation workflow
- [Delete base workflow](https://help.teable.ai/en/api-reference/automation/delete-base-workflow.md): delete a automation workflow
- [Get base workflow active snapshot](https://help.teable.ai/en/api-reference/automation/get-base-workflow-active-snapshot.md): Get the currently active (published) snapshot of a workflow. Returns the version that is actually running, as opposed to the draft version returned by getWorkflow.
- [Get base workflow 1](https://help.teable.ai/en/api-reference/automation/get-base-workflow-1.md): get automation workflow list in base
- [Post base workflow](https://help.teable.ai/en/api-reference/automation/post-base-workflow.md): Create a automation workflow
- [Put base workflow active](https://help.teable.ai/en/api-reference/automation/put-base-workflow-active.md): active or inactive a automation workflow
- [Get base workflow run](https://help.teable.ai/en/api-reference/automation/get-base-workflow-run.md): get automation workflow run list
- [Get base workflow run 1](https://help.teable.ai/en/api-reference/automation/get-base-workflow-run-1.md): get automation workflow run history list
- [Get base workflow runsummary](https://help.teable.ai/en/api-reference/automation/get-base-workflow-runsummary.md): get automation workflow run summary statistics
- [Post base workflow test](https://help.teable.ai/en/api-reference/automation/post-base-workflow-test.md): test a automation workflow node
- [Post base workflow test all](https://help.teable.ai/en/api-reference/automation/post-base-workflow-test-all.md): test a automation workflow all
- [Put base workflow order](https://help.teable.ai/en/api-reference/automation/put-base-workflow-order.md): Update workflow order
- [Post base workflow filter link records](https://help.teable.ai/en/api-reference/automation/post-base-workflow-filter-link-records.md): get automation workflow list in base
- [Post base workflow duplicate](https://help.teable.ai/en/api-reference/automation/post-base-workflow-duplicate.md): duplicate a automation workflow
- [Permanently delete workflow](https://help.teable.ai/en/api-reference/automation/permanently-delete-workflow.md): Permanently delete a workflow and all its data. This action cannot be undone.

#### authority-matrix

- [Patch base authority matrixstatus](https://help.teable.ai/en/api-reference/authority-matrix/patch-base-authority-matrixstatus.md): Enable authority
- [Get base authority matrix](https://help.teable.ai/en/api-reference/authority-matrix/get-base-authority-matrix.md): Get authority matrix
- [Put base authority matrix](https://help.teable.ai/en/api-reference/authority-matrix/put-base-authority-matrix.md): Update authority matrix
- [Patch base authority matrixadmin user](https://help.teable.ai/en/api-reference/authority-matrix/patch-base-authority-matrixadmin-user.md): Update admin user
- [Get base authority matrix role](https://help.teable.ai/en/api-reference/authority-matrix/get-base-authority-matrix-role.md): Get authority matrix role list
- [Post base authority matrix role](https://help.teable.ai/en/api-reference/authority-matrix/post-base-authority-matrix-role.md): Add authority matrix role
- [Get base authority matrix role 1](https://help.teable.ai/en/api-reference/authority-matrix/get-base-authority-matrix-role-1.md): Get authority matrix role
- [Put base authority matrix role](https://help.teable.ai/en/api-reference/authority-matrix/put-base-authority-matrix-role.md): Update authority matrix role
- [Delete base authority matrix role](https://help.teable.ai/en/api-reference/authority-matrix/delete-base-authority-matrix-role.md): Delete authority matrix role
- [Patch base authority matrix role status](https://help.teable.ai/en/api-reference/authority-matrix/patch-base-authority-matrix-role-status.md): Update authority matrix role status
- [Patch base authority matrix role name](https://help.teable.ai/en/api-reference/authority-matrix/patch-base-authority-matrix-role-name.md): Update authority matrix role name
- [Patch base authority matrix role description](https://help.teable.ai/en/api-reference/authority-matrix/patch-base-authority-matrix-role-description.md): Update authority matrix role description
- [Patch base authority matrix role user](https://help.teable.ai/en/api-reference/authority-matrix/patch-base-authority-matrix-role-user.md): Update authority matrix role user
- [Post base authority matrix role duplicate](https://help.teable.ai/en/api-reference/authority-matrix/post-base-authority-matrix-role-duplicate.md): Duplicate authority matrix role
- [Get base authority matrix role table filter link records](https://help.teable.ai/en/api-reference/authority-matrix/get-base-authority-matrix-role-table-filter-link-records.md): Get authority matrix table link records

#### app

- [Patch base app files](https://help.teable.ai/en/api-reference/app/patch-base-app-files.md): Update app files
- [Patch base app props](https://help.teable.ai/en/api-reference/app/patch-base-app-props.md): Update app props
- [Post base app run](https://help.teable.ai/en/api-reference/app/post-base-app-run.md): Run the app code
- [Get base app export code](https://help.teable.ai/en/api-reference/app/get-base-app-export-code.md): Export app source code as a ZIP file
- [Post base app import code](https://help.teable.ai/en/api-reference/app/post-base-app-import-code.md): Import app source code from a ZIP file
- [Post base app deploy](https://help.teable.ai/en/api-reference/app/post-base-app-deploy.md): Deploy app to Vercel
- [Get base app deploystatus](https://help.teable.ai/en/api-reference/app/get-base-app-deploystatus.md): Get app deployment status
- [Delete app](https://help.teable.ai/en/api-reference/app/delete-app.md): Delete app by its ID.
- [Permanently delete app](https://help.teable.ai/en/api-reference/app/permanently-delete-app.md): Permanently delete an app and all its data. This action cannot be undone.

#### enterprise

- [Get enterprise authentication](https://help.teable.ai/en/api-reference/enterprise/get-enterprise-authentication.md): Get a authentication
- [Put enterprise authentication](https://help.teable.ai/en/api-reference/enterprise/put-enterprise-authentication.md): Update a authentication
- [Delete enterprise authentication](https://help.teable.ai/en/api-reference/enterprise/delete-enterprise-authentication.md): Delete a authentication
- [Get enterprise authentication 1](https://help.teable.ai/en/api-reference/enterprise/get-enterprise-authentication-1.md): Get a authentication list
- [Post enterprise authentication](https://help.teable.ai/en/api-reference/enterprise/post-enterprise-authentication.md): Create a authentication
- [Get enterprise authenticationproviders](https://help.teable.ai/en/api-reference/enterprise/get-enterprise-authenticationproviders.md): Get providers
- [Get enterprise domain verification](https://help.teable.ai/en/api-reference/enterprise/get-enterprise-domain-verification.md): Get a domain verification
- [Post enterprise domain verification](https://help.teable.ai/en/api-reference/enterprise/post-enterprise-domain-verification.md): Create a domain verification
- [Delete enterprise domain verification](https://help.teable.ai/en/api-reference/enterprise/delete-enterprise-domain-verification.md): Delete a domain verification
- [Post enterprise domain verificationsend verification email](https://help.teable.ai/en/api-reference/enterprise/post-enterprise-domain-verificationsend-verification-email.md): Send email verification

#### space-manage

- [Get enterprise space managecount](https://help.teable.ai/en/api-reference/space-manage/get-enterprise-space-managecount.md): Get space manage list total
- [Get enterprise space manage](https://help.teable.ai/en/api-reference/space-manage/get-enterprise-space-manage.md): Get space manage list
- [Delete enterprise space manage remove organization](https://help.teable.ai/en/api-reference/space-manage/delete-enterprise-space-manage-remove-organization.md): Remove space from organization
- [Post enterprise space manage add organization](https://help.teable.ai/en/api-reference/space-manage/post-enterprise-space-manage-add-organization.md): Add space to organization
- [Get enterprise space manage 1](https://help.teable.ai/en/api-reference/space-manage/get-enterprise-space-manage-1.md): Get space manage detail

#### chat

- [Post base chatcreate](https://help.teable.ai/en/api-reference/chat/post-base-chatcreate.md): Create chat
- [Get base chat messages](https://help.teable.ai/en/api-reference/chat/get-base-chat-messages.md): Get chat messages
- [Delete base chat messages](https://help.teable.ai/en/api-reference/chat/delete-base-chat-messages.md): Clear all messages in a chat
- [Get base chathistory](https://help.teable.ai/en/api-reference/chat/get-base-chathistory.md): Get chat history
- [Delete base chat delete](https://help.teable.ai/en/api-reference/chat/delete-base-chat-delete.md)
- [Patch base chat rename](https://help.teable.ai/en/api-reference/chat/patch-base-chat-rename.md)
- [Post base chat stop](https://help.teable.ai/en/api-reference/chat/post-base-chat-stop.md): Stop an active chat stream and prevent resume
- [Post base chatsuggestions](https://help.teable.ai/en/api-reference/chat/post-base-chatsuggestions.md)
- [Get chatonboardingscenarios](https://help.teable.ai/en/api-reference/chat/get-chatonboardingscenarios.md): Get onboarding scenarios with presigned URLs for attachments
- [Post chatonboardingattachments](https://help.teable.ai/en/api-reference/chat/post-chatonboardingattachments.md): Get attachment info by tokens. Used for landing page onboarding flow.
- [Post base chattext extract](https://help.teable.ai/en/api-reference/chat/post-base-chattext-extract.md): Extract text content from attachments
- [Post base chatexecute script](https://help.teable.ai/en/api-reference/chat/post-base-chatexecute-script.md): Execute TypeScript code in sandbox for chat tools
- [Post base chatresolve attachments](https://help.teable.ai/en/api-reference/chat/post-base-chatresolve-attachments.md): Resolve attachment tokens to presigned URLs

#### reward

- [Claim a reward](https://help.teable.ai/en/api-reference/reward/claim-a-reward.md): Submit a reward claim (e.g., social share)
- [Get reward credit list](https://help.teable.ai/en/api-reference/reward/get-reward-credit-list.md): Get reward credit list for a space
- [Get reward details](https://help.teable.ai/en/api-reference/reward/get-reward-details.md): Get details of a specific reward including its verification status

## OpenAPI Specs

- [swagger](/swagger.json)