Web API

Press shift + S to search API reference.

Collaborators

Add workspace collaborator

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

Add a new workspace collaborator. Despite the name, this route currently only supports adding one collaborator at a time.

Requirements

AuthenticationPersonal access token, OAuth integration
ScopeworkspacesAndBases:write
User role

Workspace collaborators subject to sharing restrictions

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

Path parameters

workspaceId
string

Request body

collaborators
array of any of the below objects

This endpoint accepts two types of collaborators: individual user and group.


permissionLevel
Workspace Permission Levels
user
object
id
string

A user ID


permissionLevel
Workspace Permission Levels
group
object
id
string

A user group ID

Response format

This endpoint returns an empty response on success.

Error responses

Add more than one collaborator (403)
This route currently supports adding only one collaborator at a time.
{
"error": {
"message": "You are only permitted to add one collaborator at a time",
"type": "INVALID_PERMISSIONS"
}
}
Email not verified (403)
The userId must correspond to a verified account.
{
"error": {
"message": "User must be active and email verified",
"type": "INVALID_PERMISSIONS"
}
}
Groups cannot be owners (403)
Cannot assign a group as a workspace owner.
{
"error": {
"message": "Groups cannot be the owners of a workspace",
"type": "INVALID_PERMISSIONS"
}
}
Request (example)
Copy
$
curl -X POST "https://api.airtable.com/v0/meta/workspaces/{workspaceId}/collaborators" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"collaborators": [
{
"permissionLevel": "edit",
"user": {
"id": "usr00000000000000"
}
}
]
}'