Apitable icon

Apitable

Interact with Apitable API

Field → Field List

AI-generated

Overview

This node interacts with the Apitable API to list fields from a specified datasheet. It is useful when you want to retrieve metadata about the columns (fields) in an Apitable datasheet, for example, to dynamically generate UI elements or to process data based on field definitions.

A practical use case is when automating workflows that depend on the structure of a datasheet, such as syncing column names or validating input data against existing fields.

Properties

Name Meaning
Datasheet Id The unique identifier of the Apitable datasheet from which to list fields.
Additional Fields Optional parameters to refine the request:
- View Id Limits the fields returned to those visible in a specific view within the datasheet. If not specified, all fields are returned.

Output

The node outputs JSON data representing the list of fields retrieved from the specified datasheet. Each item in the output corresponds to a field and typically includes properties such as field name, type, id, and other metadata describing the field.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the Apitable API.
  • The node depends on the Apitable API endpoint URL configured in the credentials.
  • Uses internal methods to load options dynamically for Datasheets and Views, facilitating user selection in the node UI.

Troubleshooting

  • Missing or invalid Datasheet Id: The node requires a valid datasheet ID; ensure it is correctly selected or entered.
  • API authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • View Id filtering issues: If specifying a View Id returns no fields, confirm that the view exists and contains fields.
  • Network or API errors: Check connectivity and Apitable service status if requests fail.

Links and References

Discussion