Scripting
Model

Collaborator

A user or user group collaborator in your base.

Note: Adding user groups to multiple collaborator fields is an upcoming enterprise feature currently in beta, and will be generally released on August 29, 2022.

Example
console.log(base.activeCollaborators);

id

typedef
string

The user or user group ID of the collaborator.

Example
// Get the id of a collaborator:
let collaborator = base.getCollaborator("logan.grandmont@airtable.com");
console.log(`Collaborator ID: ${collaborator.id}`);

name

typedef
string | null

The name of the collaborator. Could be null if the user's Airtable account doesn't yet have a name.

Example
// Get the name of a collaborator:
let collaborator = base.getCollaborator("jess.patel@airtable.com");
console.log(`Collaborator name: ${collaborator.name}`);

email

typedef
string

The email address of the user collaborator or an RFC 2822 mailbox-list (comma-separated list of emails) that can be used to contact all members of the user group collaborator.

Example
// Get the email of a collaborator:
let collaborator = base.getCollaborator("usrJvI5r9PM8Axycb");
console.log(`Collaborator email: ${collaborator.email}`);

profilePicUrl

typedef
string | null

The URL of the collaborator's profile picture. Could be null if the user's Airtable account hasn't set a profile picture or the collaborator is a user group.

Example
// Show the profile picture of a collaborator:
let collaborator = base.getCollaborator("sandy.hagen@airtable.com");
console.log(`Collaborator picture: ![profile picture](${collaborator.profilePicUrl})`);