Description

Input Parameters

{
  "parameters": [
    {
      "name": "base_id",
      "required": true,
      "inferrable": true,
      "description": "The unique identifier for the Airtable base where the table is located.",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "table_id_or_name",
      "required": true,
      "inferrable": true,
      "description": "The ID or name of the Airtable table to retrieve records from. Using table IDs is recommended for consistency.",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "cell_format_method",
      "required": false,
      "inferrable": true,
      "description": "Defines how cell values are returned. Specify 'json' for unformatted or 'string' for formatted values.",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "filter_by_formula",
      "required": false,
      "inferrable": true,
      "description": "A formula string to filter records. Use Airtable's formula syntax where functions and operators will be applied to fields.",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "maximum_records",
      "required": false,
      "inferrable": true,
      "description": "Specify the maximum number of records to retrieve from the Airtable table.",
      "value_schema": {
        "val_type": "number"
      }
    },
    {
      "name": "output_time_zone",
      "required": false,
      "inferrable": true,
      "description": "Specifies the time zone for datetimes returned in records. Use IANA time zone format (e.g., 'America/Los_Angeles').",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "page_size",
      "required": false,
      "inferrable": true,
      "description": "Number of records per page to fetch. Default is 100.",
      "value_schema": {
        "val_type": "number"
      }
    },
    {
      "name": "pagination_offset",
      "required": false,
      "inferrable": true,
      "description": "A string used for pagination to fetch the next set of records. Use the offset provided in the previous response to continue retrieving records.",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "record_metadata_fields",
      "required": false,
      "inferrable": true,
      "description": "An array of strings specifying which metadata fields to include for each record.",
      "value_schema": {
        "val_type": "array",
        "inner_val_type": "string"
      }
    },
    {
      "name": "return_fields_by_field_id",
      "required": false,
      "inferrable": true,
      "description": "Return fields by their field ID instead of field name when set to true.",
      "value_schema": {
        "val_type": "boolean"
      }
    },
    {
      "name": "sort_order",
      "required": false,
      "inferrable": true,
      "description": "Specifies the order of records. Use a JSON string with fields and directions (asc or desc).",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "specific_fields",
      "required": false,
      "inferrable": true,
      "description": "Comma-separated list of field names to be included in the response. If omitted, all fields are returned.",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "specified_view",
      "required": false,
      "inferrable": true,
      "description": "Specifies the view in the table to be used for record retrieval. Provide the name or ID of the view.",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "user_locale",
      "required": false,
      "inferrable": true,
      "description": "Specify the user locale to determine the language and regional settings for the records.",
      "value_schema": {
        "val_type": "string"
      }
    }
  ]
}

Output

{
  "description": "Response from the API endpoint 'list-records'.",
  "value_schema": {
    "val_type": "json"
  },
  "available_modes": [
    "value",
    "error"
  ]
}