Web API

Press shift + S to search API reference.

Shares

List shares

gethttps://api.airtable.com/v0/meta/bases/{baseId}/shares

Lists basic information of base shares.

Requirements

AuthenticationPersonal access token, OAuth integration
ScopeworkspacesAndBases.shares:manage
User role

Base editor

Billing plansEnterprise (pre-2023.08 legacy plan), Enterprise Scale

Path parameters

baseId
string

Response format

shares
array of the below object
state
"enabled" | "disabled"
createdByUserId
string

A user ID

createdTime
string

A date timestamp in the ISO format, eg:"2018-01-01T00:00:00.000Z"

shareId
string

The full ShareId (unique identifier for the share).

shareTokenPrefix
string
This property is deprecated

Only the first 8 characters of the shareId.

Please use shareId instead.

type
"base" | "view" | "blockInstallation"
canBeSynced
optional<boolean>

Denotes if the shared view can be synced. View and enterprise specific sync restrictions may also apply.

isPasswordProtected
boolean
blockInstallationId
optional<string>
restrictedToEmailDomains
array of strings

If non-empty, the email domain restrictions assigned to the share. If empty, no domain restrictions are assigned to the share, but higher level ones may still affect it. We recommend using effectiveEmailDomainAllowList to understand share accessibility.

viewId
optional<string>
effectiveEmailDomainAllowList
optional<array of strings>

The effective email domain allow list factoring all restrictions, including the share's email domain restrictions and all restrictions above the share (e.g. enterprise sharing restrictions). If this field is omitted, there are no email domain restrictions on the share. Otherwise, a viewer must have an account associated with an email domain included in the allow list. If this list is empty, no viewer can see the share (e.g. no member of restrictedToEmailDomains is allowed by enterprise-wise sharing restrictions).

Request (example)
Copy
$
curl "https://api.airtable.com/v0/meta/bases/{baseId}/shares" \
-H "Authorization: Bearer YOUR_TOKEN"
200 – Response (example)
{
"shares": [
{
"createdByUserId": "usrL2PNC5o3H4lBEi",
"createdTime": "2019-01-01T00:00:00.000Z",
"effectiveEmailDomainAllowList": [
"foobar.com"
],
"isPasswordProtected": true,
"restrictedToEmailDomains": [
"foobar.com"
],
"shareId": "shr9SpczJvQpfAzSp",
"shareTokenPrefix": "shr9Spcz",
"state": "enabled",
"type": "base"
},
{
"canBeSynced": true,
"createdByUserId": "usrL2PNC5o3H4lBEi",
"createdTime": "2019-01-01T00:00:00.000Z",
"isPasswordProtected": false,
"restrictedToEmailDomains": [],
"shareId": "shrMg5vs9SpczJvQp",
"shareTokenPrefix": "shrMg5vs",
"state": "disabled",
"type": "view",
"viewId": "viwQpsuEDqHFqegkp"
},
{
"blockInstallationId": "bliXyN0Q6zfajnDOG",
"createdByUserId": "usrL2PNC5o3H4lBEi",
"createdTime": "2019-01-01T00:00:00.000Z",
"isPasswordProtected": false,
"restrictedToEmailDomains": [],
"shareId": "shrjjKdhMg5vs9Spc",
"shareTokenPrefix": "shrjjKdh",
"state": "disabled",
"type": "blockInstallation"
}
]
}