工具 API

list_records_for_page

Lists records from an interface page. Pages may display data from one table (simple pages) or multiple related tables (hierarchy pages, e.g. projects → tasks). The response contains recordsByTableId, a map from table ID to the records from that table. For simple pages this has one entry; for hierarchy pages it has one entry per configured level. Use the table IDs from list_pages_for_base to identify which table is which. Use this for bases with permissionLevel "interfaceOnly" or "none" (interface-only access), or when the user asks about interface/page data. Do not assume baseId. Obtain it from search_bases or list_bases. Use list_pages_for_base to find the pageId or interfaceId if needed. If filtering or selecting specific fields, use list_pages_for_base if needed to find the field IDs and select choice IDs for the fieldIds and filters params.

productivityOAuth1 积分

调用信息

工具标识
airtable.list_records_for_page
服务提供方
Airtable
平均响应
0 ms
近 7 天调用
0

输入参数

baseId必填

The ID of the base (application) containing the page. Must start with "app" and is 17 characters long. Example: "appZfrNIUEip5MazD". Do not substitute user-facing names for baseId. To get baseId, use the search_bases or list_bases tool.

pageId必填

The ID of the interface page to read records from. Must start with "pag" and is 17 characters long. Example: "pagXxYyZzAaBbCcDd".

interfaceId必填

The ID of the interface that contains the page. Must start with "pbd" and is 17 characters long.

elementId

The ID of a specific element to query records for. Required for dashboard pages. Obtain element IDs from the dashboardElements array in the list_pages_for_base response. Must start with "pel" and is 17 characters long.

fieldIds

Only data for fields whose IDs are in this list will be included in the result. Pass in only the fields most useful for the user to see. If not provided, the fields visible in the page element's visualization will be returned. For hierarchy pages, field IDs are matched against each table — a field belonging to the projects table will filter the projects records, and one belonging to the tasks table will filter the tasks records. You can mix field IDs from different tables. Field IDs must start with "fld" and is 17 characters long. Example: "fldGlRtkBNWfYnPOV". Do not substitute user-facing names for IDs. To get fieldId, use the list_tables_for_base tool. For interface-only bases, use the field IDs from the list_pages_for_base response instead.

pageSize

The maximum number of records to return in the response. The server may respond with fewer records than this value when the total set has fewer records than this value.

filters

Additional filters to apply on top of the page element's built-in filters. These are combined with the element's static filters using AND. For hierarchy pages, filters apply only to the source level's table. Related levels may be constrained indirectly through the hierarchy's foreign key relationships. Describes the filters to apply to the records using a structured format. Example filter where the value of the field with ID "fld8WsrpLHHevsnW8" is "orange" or the value of the field with ID "fldulcCPDVz87Bmnw" is greater than 5: {"operator": "or", "operands": [{"operator": "=", "operands": ["fld8WsrpLHHevsnW8", "orange"]}, {"operator": ">", "operands": ["fldulcCPDVz87Bmnw", 5]}]} Example filter where the value of the collaborator field with ID "fldCRi9oz2vRLcIWr" can be any user in a group with ID "ugpDUVUnftA7H9bG8" and the value of the field with ID "fldgD18XtsueoiguT" equals select option with ID "selha8nGNAT5ATR7P": {"operator": "and", "operands": [{"operator": "hasAnyOf", "operands": ["fldCRi9oz2vRLcIWr", "ugpDUVUnftA7H9bG8"], "operatorOptions": {"matchGroupsByMembership": true}}, {"operator": "=", "operands": ["fldgD18XtsueoiguT", "selha8nGNAT5ATR7P"]}]} Example filter for records where a date field is within the past week: {"operands": [{"operator": "isWithin", "operands": ["fldABC12345678x", {"mode": "pastWeek", "timeZone": "America/New_York"}]}]} Example filter for records where a field is not empty: {"operands": [{"operator": "isNotEmpty", "operands": ["fldABC12345678x"]}]}