Skip to main content
This API returns a paginated list of tables contained within a specific schema. Each table represents a Delta Lake table or view.

Request

method
string
required
GET
url
string
required
{prefix}/shares/{share}/schemas/{schema}/tables

Headers

Authorization
string
required
Bearer token for authentication
Authorization: Bearer {token}

URL Parameters

share
string
required
The share name to query. This parameter is case-insensitive.
schema
string
required
The schema name to query. This parameter is case-insensitive.

Query Parameters

maxResults
Int32
The maximum number of results per page that should be returned.
  • Must be non-negative
  • 0 will return no results but nextPageToken may be populated
  • Server may return fewer items even if more are available
pageToken
String
Specifies a page token to use. Set to the nextPageToken returned by a previous list request to get the next page of results.

Response

items
array
Array of table objects. May be an empty array or missing when no results are found.
nextPageToken
string
Token for retrieving the next page of results. May be an empty string or missing when there are no additional results.

Example Request

curl -X GET \
  '{prefix}/shares/vaccine_share/schemas/acme_vaccine_data/tables?maxResults=10' \
  -H 'Authorization: Bearer {token}'

Example Response

{
  "items": [
    {
      "share": "vaccine_share",
      "schema": "acme_vaccine_data",
      "name": "vaccine_ingredients",
      "shareId": "edacc4a7-6600-4fbb-85f3-a62a5ce6761f",
      "id": "dcb1e680-7da4-4041-9be8-88aff508d001"
    },
    {
      "share": "vaccine_share",
      "schema": "acme_vaccine_data",
      "name": "vaccine_patients",
      "shareId": "edacc4a7-6600-4fbb-85f3-a62a5ce6761f",
      "id": "c48f3e19-2c29-4ea3-b6f7-3899e53338fa"
    }
  ],
  "nextPageToken": "..."
}

Error Responses

Access Modes

The accessModes field indicates how clients can access table data:
  • URL-based access (url): Server returns pre-signed URLs for individual files
  • Directory-based access (dir): Server issues temporary cloud credentials for direct storage access
If accessModes is not present, assume URL-based access only.

Build docs developers (and LLMs) love