Web API

Press shift + S to search API reference.

Collaborators

Get interface

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

Returns general information about the interface. Does not include deleted collaborators and only includes outstanding invites.

pageBundleId is the ID of the interface and can be found in the interfaces object returned by the get base collaborators endpoint.

Requirements

AuthenticationPersonal access token, OAuth integration
ScopeworkspacesAndBases:read
User role

Base read-only

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

Path parameters

baseId
string
pageBundleId
string

Query parameters

include
optional<array of ("collaborators" | "inviteLinks")>

Response format

id
string
baseId
string

Base ID, a unique identifier for a base.

createdTime
string

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

name
string
permissionLevel
"none" | "read" | "comment" | "edit" | "create" | "owner"
groupCollaborators
optional<object>
baseCollaborators
array of Group Collaborators
interfaceCollaborators
array of Group Collaborators
workspaceCollaborators
array of Group Collaborators
individualCollaborators
optional<object>
baseCollaborators
array of Individual Collaborators
interfaceCollaborators
array of Individual Collaborators
workspaceCollaborators
array of Individual Collaborators
inviteLinks
optional<array of Invite links>