---
updatedAt: 2026-04-29T23:07:57.000Z
agentTools:
  projectIndex: https://docs.bigeye.com/llms.txt
---

# Get tables

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Metadata",
    "version": "version not set"
  },
  "paths": {
    "/api/v1/tables/fetch": {
      "post": {
        "operationId": "TableService_GetTables",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/generatedGetTableListRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/generatedGetTableListResponse"
                }
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runtimeError"
                }
              }
            }
          }
        },
        "summary": "Get tables",
        "tags": [
          "TableService"
        ]
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    },
    {
      "Personal_API_Key": []
    }
  ],
  "servers": [
    {
      "url": "https://app.bigeye.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      },
      "Personal_API_Key": {
        "description": "Add 'apikey ' to the beginning of your api key",
        "in": "header",
        "name": "Authorization",
        "type": "apiKey"
      }
    },
    "schemas": {
      "generatedGetTableListRequest": {
        "properties": {
          "ignoreFields": {
            "type": "boolean"
          },
          "includeDataNodeIds": {
            "type": "boolean"
          },
          "pageCursor": {
            "type": "string"
          },
          "pageSize": {
            "format": "int32",
            "type": "integer"
          },
          "schemaIds": {
            "items": {
              "format": "int32",
              "type": "integer"
            },
            "type": "array"
          },
          "search": {
            "type": "string"
          },
          "sortDirection": {
            "$ref": "#/components/schemas/generatedSortDirection"
          },
          "sortField": {
            "$ref": "#/components/schemas/generatedTableSortField"
          },
          "sourceConnectionTypes": {
            "items": {
              "$ref": "#/components/schemas/generatedSourceConnectionType"
            },
            "type": "array"
          },
          "sourceIds": {
            "items": {
              "format": "int32",
              "type": "integer"
            },
            "type": "array"
          },
          "tableIds": {
            "items": {
              "format": "int32",
              "type": "integer"
            },
            "type": "array"
          },
          "tagIds": {
            "items": {
              "format": "int32",
              "type": "integer"
            },
            "type": "array"
          },
          "workspaceId": {
            "format": "int32",
            "type": "integer"
          }
        },
        "type": "object"
      },
      "generatedGetTableListResponse": {
        "properties": {
          "paginationInfo": {
            "$ref": "#/components/schemas/generatedPaginationInfo"
          },
          "tables": {
            "items": {
              "$ref": "#/components/schemas/generatedTable"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "generatedPaginationInfo": {
        "properties": {
          "firstSortDistinctValues": {
            "format": "int64",
            "type": "string"
          },
          "nextCursor": {
            "type": "string"
          },
          "noNumRecords": {
            "type": "boolean"
          },
          "numRecords": {
            "format": "int32",
            "type": "integer"
          },
          "prevCursor": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "generatedSchema": {
        "description": "*\nRepresentation of a schema in a warehouse.",
        "properties": {
          "dataNodeId": {
            "format": "int32",
            "type": "integer"
          },
          "databaseType": {
            "$ref": "#/components/schemas/generatedWarehouseType"
          },
          "id": {
            "format": "int32",
            "type": "integer"
          },
          "indexByTable": {
            "type": "boolean"
          },
          "isFavorite": {
            "type": "boolean"
          },
          "isVirtual": {
            "type": "boolean"
          },
          "latestMetricTimeValue": {
            "format": "int64",
            "type": "string"
          },
          "logicalSizeBytes": {
            "format": "int64",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "numQueriesLatestPeriod": {
            "format": "int32",
            "type": "integer"
          },
          "popularityScore": {
            "format": "double",
            "type": "number"
          },
          "schemaChangeInfo": {
            "$ref": "#/components/schemas/generatedSchemaChangeInfo"
          },
          "sizeLastUpdatedAtMillis": {
            "format": "int64",
            "type": "string"
          },
          "tags": {
            "items": {
              "$ref": "#/components/schemas/generatedTag"
            },
            "type": "array"
          },
          "warehouseId": {
            "format": "int64",
            "type": "string"
          },
          "warehouseName": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "generatedSchemaChangeInfo": {
        "properties": {
          "initialSchemaScanAt": {
            "format": "int64",
            "type": "string"
          },
          "lastSchemaChangeAt": {
            "format": "int64",
            "type": "string"
          },
          "mostRecentSchemaScanAt": {
            "format": "int64",
            "type": "string"
          }
        },
        "type": "object"
      },
      "generatedSortDirection": {
        "default": "SORT_DIRECTION_UNSPECIFIED",
        "enum": [
          "SORT_DIRECTION_UNSPECIFIED",
          "SORT_DIRECTION_ASCENDING",
          "SORT_DIRECTION_DESCENDING"
        ],
        "title": "Unspecified will default to ASCENDING",
        "type": "string"
      },
      "generatedSourceConnectionType": {
        "default": "SOURCE_CONNECTION_TYPE_UNSPECIFIED",
        "enum": [
          "SOURCE_CONNECTION_TYPE_UNSPECIFIED",
          "SOURCE_CONNECTION_TYPE_DIRECT_CONNECT",
          "SOURCE_CONNECTION_TYPE_AGENT"
        ],
        "type": "string"
      },
      "generatedTable": {
        "description": "*\nRepresentation of a table in a warehouse.",
        "properties": {
          "columns": {
            "items": {
              "$ref": "#/components/schemas/generatedTableColumn"
            },
            "type": "array"
          },
          "dataNodeId": {
            "format": "int32",
            "type": "integer"
          },
          "databaseName": {
            "type": "string"
          },
          "id": {
            "format": "int32",
            "type": "integer"
          },
          "isFavorite": {
            "type": "boolean"
          },
          "latestMetricTimeValue": {
            "format": "int64",
            "type": "string"
          },
          "logicalSizeBytes": {
            "format": "int64",
            "type": "string"
          },
          "metricTimeColumn": {
            "$ref": "#/components/schemas/generatedTableColumn"
          },
          "name": {
            "type": "string"
          },
          "numQueriesLatestPeriod": {
            "format": "int32",
            "type": "integer"
          },
          "popularityScore": {
            "format": "double",
            "type": "number"
          },
          "requiresPartitionFilter": {
            "type": "boolean"
          },
          "schema": {
            "$ref": "#/components/schemas/generatedSchema"
          },
          "schemaChangeInfo": {
            "$ref": "#/components/schemas/generatedSchemaChangeInfo"
          },
          "schemaId": {
            "format": "int32",
            "type": "integer"
          },
          "schemaName": {
            "type": "string"
          },
          "sizeLastUpdatedAtMillis": {
            "format": "int64",
            "type": "string"
          },
          "tableType": {
            "$ref": "#/components/schemas/generatedTableType"
          },
          "tags": {
            "items": {
              "$ref": "#/components/schemas/generatedTag"
            },
            "type": "array"
          },
          "usesAgent": {
            "type": "boolean"
          },
          "warehouseId": {
            "format": "int32",
            "type": "integer"
          },
          "warehouseName": {
            "type": "string"
          },
          "warehouseVendor": {
            "$ref": "#/components/schemas/generatedWarehouseType"
          }
        },
        "type": "object"
      },
      "generatedTableColumn": {
        "description": "*\nRepresentation of a column in a table.",
        "properties": {
          "canBeMetricTime": {
            "type": "boolean"
          },
          "dataNodeId": {
            "format": "int32",
            "type": "integer"
          },
          "extendedType": {
            "type": "string"
          },
          "fullType": {
            "type": "string"
          },
          "id": {
            "format": "int32",
            "type": "integer"
          },
          "isFavorite": {
            "type": "boolean"
          },
          "isKeyInJoin": {
            "type": "boolean"
          },
          "isMetricTime": {
            "type": "boolean"
          },
          "isNullable": {
            "type": "boolean"
          },
          "isPartitionField": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "parentColumnId": {
            "format": "int32",
            "type": "integer"
          },
          "schemaChangeInfo": {
            "$ref": "#/components/schemas/generatedSchemaChangeInfo"
          },
          "tags": {
            "items": {
              "$ref": "#/components/schemas/generatedTag"
            },
            "type": "array"
          },
          "type": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "generatedTableSortField": {
        "default": "TABLE_SORT_FIELD_UNSPECIFIED",
        "enum": [
          "TABLE_SORT_FIELD_UNSPECIFIED",
          "TABLE_SORT_FIELD_NAME",
          "TABLE_SORT_FIELD_LAST_SCHEMA_CHANGE",
          "TABLE_SORT_FIELD_FAVORITE",
          "TABLE_SORT_FIELD_LAST_UPDATED",
          "TABLE_SORT_FIELD_POPULARITY",
          "TABLE_SORT_FIELD_NAME_LENGTH"
        ],
        "type": "string"
      },
      "generatedTableType": {
        "default": "TABLE_TYPE_UNSPECIFIED",
        "enum": [
          "TABLE_TYPE_UNSPECIFIED",
          "TABLE_TYPE_TABLE",
          "TABLE_TYPE_VIEW",
          "TABLE_TYPE_VIRTUAL",
          "TABLE_TYPE_CUSTOM_RULE"
        ],
        "type": "string"
      },
      "generatedTag": {
        "properties": {
          "colorHex": {
            "title": "color_hex includes a # prefix (e.g. “#181818” is correct, “181818” is incorrect)",
            "type": "string"
          },
          "createdAt": {
            "format": "int64",
            "type": "string"
          },
          "id": {
            "format": "int32",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "updatedAt": {
            "format": "int64",
            "type": "string"
          },
          "workspaceId": {
            "format": "int32",
            "type": "integer"
          }
        },
        "title": "Tags",
        "type": "object"
      },
      "generatedWarehouseType": {
        "default": "DATABASE_TYPE_UNSPECIFIED",
        "enum": [
          "DATABASE_TYPE_UNSPECIFIED",
          "DATABASE_TYPE_AWS_ATHENA",
          "DATABASE_TYPE_BIGQUERY",
          "DATABASE_TYPE_DATABRICKS",
          "DATABASE_TYPE_MYSQL",
          "DATABASE_TYPE_ORACLE",
          "DATABASE_TYPE_POSTGRES",
          "DATABASE_TYPE_PRESTO",
          "DATABASE_TYPE_REDSHIFT",
          "DATABASE_TYPE_SAP_HANA",
          "DATABASE_TYPE_SNOWFLAKE",
          "DATABASE_TYPE_SQL_SERVER",
          "DATABASE_TYPE_SYNAPSE",
          "DATABASE_TYPE_ROCKSET",
          "DATABASE_TYPE_VERTICA",
          "DATABASE_TYPE_AVATICA",
          "DATABASE_TYPE_DB2",
          "DATABASE_TYPE_TERADATA",
          "DATABASE_TYPE_NETEZZA",
          "DATABASE_TYPE_SALESFORCE"
        ],
        "type": "string"
      },
      "protobufAny": {
        "properties": {
          "typeUrl": {
            "type": "string"
          },
          "value": {
            "format": "byte",
            "type": "string"
          }
        },
        "type": "object"
      },
      "runtimeError": {
        "properties": {
          "code": {
            "format": "int32",
            "type": "integer"
          },
          "details": {
            "items": {
              "$ref": "#/components/schemas/protobufAny"
            },
            "type": "array"
          },
          "error": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  }
}
```