Web API

Press shift + S to search API reference.

Collaborators

Get base collaborators

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

Returns basic information on the base. Does not include deleted collaborators and only include outstanding invites.

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

Query parameters

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

If specified, collaborators, interfaces and/or inviteLinks key will be included in the response object. Otherwise, they will be left out.

Response format

id
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"

permissionLevel
"none" | "read" | "comment" | "edit" | "create" | "owner"

Collaborator permission level of the endpoint authenticator in the base. "none" for enterprise admin who is not a collaborator in the base but has permission to this endpoint.

workspaceId
string

ID of the workspace that contains this base.

name
string
interfaces
optional<object>
The below object is keyed with a string
id
string

Interface ID (also known as pageBundleId)

createdTime
string

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

firstPublishTime
string | null
name
string
groupCollaborators
optional<array of Group Collaborators>
individualCollaborators
optional<array of Individual Collaborators>
inviteLinks
optional<array of Invite links>
collaborators
optional<object>
This property is deprecated

Please use individualCollaborators and groupCollaborators instead.

baseCollaborators
array of Individual Collaborators
workspaceCollaborators
array of Individual Collaborators
groupCollaborators
optional<object>

Groups whose members are collaborating on this base.

baseCollaborators
array of Group Collaborators
workspaceCollaborators
array of Group Collaborators
individualCollaborators
optional<object>

Individual users that are explicitly added as collaborators on the base. Does not include users that only have access via membership in a group that has been added as a collaborator.

baseCollaborators
array of Individual Collaborators
workspaceCollaborators
array of Individual Collaborators
inviteLinks
optional<object>
baseInviteLinks
array of Invite links
workspaceInviteLinks
optional<array of Invite links>
Request (example)
Copy
$
curl "https://api.airtable.com/v0/meta/bases/{baseId}\
?include[]=collaborators" \
-H "Authorization: Bearer YOUR_TOKEN"
200 – Response (example)
{
"collaborators": {
"baseCollaborators": [
{
"createdTime": "2019-01-03T12:33:12.421Z",
"email": "foo@bam.com",
"grantedByUserId": "usrL2PNC5o3H4lBEi",
"permissionLevel": "create",
"userId": "usrsOEchC9xuwRgKk"
}
],
"workspaceCollaborators": [
{
"createdTime": "2019-01-03T12:33:12.421Z",
"email": "foo@bar.com",
"grantedByUserId": "usrL2PNC5o3H4lBEi",
"permissionLevel": "owner",
"userId": "usrL2PNC5o3H4lBEi"
}
]
},
"createdTime": "2019-01-03T12:33:12.421Z",
"groupCollaborators": {
"baseCollaborators": [
{
"createdTime": "2019-01-03T12:33:12.421Z",
"grantedByUserId": "usrL2PNC5o3H4lBEi",
"groupId": "ugpR8ZT9KtIgp8Bh3",
"name": "group 2",
"permissionLevel": "create"
}
],
"workspaceCollaborators": [
{
"createdTime": "2019-01-03T12:33:12.421Z",
"grantedByUserId": "usrL2PNC5o3H4lBEi",
"groupId": "ugp1mKGb3KXUyQfOZ",
"name": "group 1",
"permissionLevel": "edit"
}
]
},
"id": "appLkNDICXNqxSDhG",
"individualCollaborators": {
"baseCollaborators": [
{
"createdTime": "2019-01-03T12:33:12.421Z",
"email": "foo@bam.com",
"grantedByUserId": "usrL2PNC5o3H4lBEi",
"permissionLevel": "create",
"userId": "usrsOEchC9xuwRgKk"
}
],
"workspaceCollaborators": [
{
"createdTime": "2019-01-03T12:33:12.421Z",
"email": "foo@bar.com",
"grantedByUserId": "usrL2PNC5o3H4lBEi",
"permissionLevel": "owner",
"userId": "usrL2PNC5o3H4lBEi"
}
]
},
"interfaces": {
"pbdyGA3PsOziEHPDE": {
"createdTime": "2019-01-03T12:33:12.421Z",
"firstPublishTime": "2019-01-03T12:36:12.421Z",
"groupCollaborators": [
{
"createdTime": "2019-01-03T12:33:12.421Z",
"grantedByUserId": "usrL2PNC5o3H4lBEi",
"groupId": "ugpR8ZT9KtIgp8Bh3",
"name": "group 2",
"permissionLevel": "create"
}
],
"id": "pbdyGA3PsOziEHPDE",
"individualCollaborators": [
{
"createdTime": "2019-01-04T12:33:12.421Z",
"email": "bam@bam.com",
"grantedByUserId": "usrL2PNC5o3H4lBEi",
"permissionLevel": "edit",
"userId": "usrGcrteE5fUMqq0R"
}
],
"inviteLinks": [
{
"createdTime": "2019-01-03T12:33:12.421Z",
"id": "invJiqaXmPqq6Ec87",
"invitedEmail": null,
"permissionLevel": "read",
"referredByUserId": "usrL2PNC5o3H4lBEi",
"restrictedToEmailDomains": [],
"type": "multiUse"
}
],
"name": "My first interface"
}
},
"inviteLinks": {
"baseInviteLinks": [
{
"createdTime": "2019-01-03T12:33:12.421Z",
"id": "invJiqaXmPqq6Ec87",
"invitedEmail": null,
"permissionLevel": "read",
"referredByUserId": "usrsOEchC9xuwRgKk",
"restrictedToEmailDomains": [
"bam.com"
],
"type": "multiUse"
}
],
"workspaceInviteLinks": [
{
"createdTime": "2019-01-03T12:33:12.421Z",
"id": "invJiqaXmPqq6Ec87",
"invitedEmail": "bam@bam.com",
"permissionLevel": "edit",
"referredByUserId": "usrL2PNC5o3H4lBEi",
"restrictedToEmailDomains": [],
"type": "singleUse"
}
]
},
"name": "my first base",
"permissionLevel": "none",
"workspaceId": "wspmhESAta6clCCwF"
}