Skip to main content
This API returns a paginated list of shares that the authenticated recipient can access. Each share is a logical grouping that can contain multiple schemas and tables.

​
Request

​
method
string
required
GET
​
url
string
required
{prefix}/shares

​
Headers

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

​
Query Parameters

​
maxResults
Int32
The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, the response will provide a nextPageToken for pagination.
  • 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 share 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?maxResults=10&pageToken=...' \
  -H 'Authorization: Bearer {token}'

​
Example Response

{
  "items": [
    {
      "name": "vaccine_share",
      "id": "edacc4a7-6600-4fbb-85f3-a62a5ce6761f",
      "displayName": "Vaccine Share",
      "comment": "A sample share containing vaccine-related datasets",
      "properties": {
        "owner": "vaccine-team",
        "region": "us-west-2",
        "created_date": "2024-01-15"
      }
    },
    {
      "name": "sales_share",
      "id": "3e979c79-6399-4dac-bcf8-54e268f48515",
      "displayName": "Sales Share",
      "comment": "A sample share containing sales and revenue data",
      "properties": {
        "owner": "sales-team",
        "region": "us-east-1",
        "created_date": "2024-02-20"
      }
    }
  ],
  "nextPageToken": "..."
}

​
Error Responses

The client must handle both empty arrays and missing items fields when no results are found. Similarly, nextPageToken may be an empty string or missing when there are no additional results.

Build docs developers (and LLMs) love

Get started for freeTalk to us