Web API

Press shift + S to search API reference.

Collaborators

Get workspace collaborators

gethttps://api.airtable.com/v0/meta/workspaces/{workspaceId}

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

Requirements

AuthenticationPersonal access token, OAuth integration
ScopeworkspacesAndBases:read
User role

Workspace read-only

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

Path parameters

workspaceId
string

Query parameters

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

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

Response format

id
string
createdTime
string

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

name
string
workspaceRestrictions
object

Sharing restrictions settings enforced on the workspace.

inviteCreationRestriction
"unrestricted" | "onlyOwners"
shareCreationRestriction
"unrestricted" | "onlyOwners"
collaborators
optional<object>
This property is deprecated

Please use individualCollaborators and groupCollaborators instead.

baseCollaborators
array of Base individual collaborators
workspaceCollaborators
array of Individual Collaborators
groupCollaborators
optional<object>

Groups whose members are collaborating on this workspace.

Note: Group cannot be owner of a workspace.

baseCollaborators
array of Base group collaborators
workspaceCollaborators
array of Group Collaborators
individualCollaborators
optional<object>

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

baseCollaborators
array of Base individual collaborators
workspaceCollaborators
array of Individual Collaborators
baseIds
array of strings
inviteLinks
optional<object>
baseInviteLinks
array of Base invite links
workspaceInviteLinks
array of Invite links
Request (example)
Copy
$
curl "https://api.airtable.com/v0/meta/workspaces/{workspaceId}" \
-H "Authorization: Bearer YOUR_TOKEN"
200 – Response (example)
{
"baseIds": [
"appLkNDICXNqxSDhG",
"appSW9R5uCNmRmfl6"
],
"collaborators": {
"baseCollaborators": [
{
"baseId": "appLkNDICXNqxSDhG",
"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": [
{
"baseId": "appLkNDICXNqxSDhG",
"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": "wspmhESAta6clCCwF",
"individualCollaborators": {
"baseCollaborators": [
{
"baseId": "appLkNDICXNqxSDhG",
"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"
}
]
},
"inviteLinks": {
"baseInviteLinks": [
{
"baseId": "appSW9R5uCNmRmfl6",
"createdTime": "2019-01-03T12:33:12.421Z",
"id": "invJiqaXmPqq6Ec87",
"invitedEmail": null,
"permissionLevel": "read",
"referredByUserId": "usrsOEchC9xuwRgKk",
"restrictedToEmailDomains": [],
"type": "multiUse"
}
],
"workspaceInviteLinks": [
{
"createdTime": "2019-01-03T12:33:12.421Z",
"id": "invJiqaXmPqq6Ec87",
"invitedEmail": "bam@bam.com",
"permissionLevel": "owner",
"referredByUserId": "usrL2PNC5o3H4lBEi",
"restrictedToEmailDomains": [
"foobar.com"
],
"type": "singleUse"
}
]
},
"name": "my first workspace",
"workspaceRestrictions": {
"inviteCreationRestriction": "onlyOwners",
"shareCreationRestriction": "unrestricted"
}
}