Web API

Press shift + S to search API reference.

Users

Get users by id or email

gethttps://api.airtable.com/v0/meta/enterpriseAccounts/{enterpriseAccountId}/users

Returns basic information relevant to both internal and external user.

Requirements

AuthenticationPersonal access token, OAuth integration
Scopeenterprise.user:read
User role

Enterprise admin

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

Path parameters

enterpriseAccountId
string

Query parameters

id
optional<array of strings>

User Ids to search by. If the request does not have any email addresses, you must include at least one userId.

email
optional<array of strings>

Email addresses to search by. If the request does not have any userIds, you must include at least one email address.

include
optional<array of ("collaborations" | "aggregated" | "descendants")>

Allows optionally including collaborations in response.

Response format

users
array of the below object
id
string

A user ID

state
"provisioned" | "deactivated"
isServiceAccount
boolean

Whether the user is a service account.

isSsoRequired
boolean

Whether the user is required to authenticate through their administrating enterprise's identity provider to login. False if user is not on an enterprise.

isTwoFactorAuthEnabled
boolean

Whether the user configured a second authentication method when logging in to Airtable through username/password auth.

lastActivityTime
string | null

Most recent time the user interacted with this enterprise account's data. null if never.

collaborations
optional<Collaborations>

The user's direct collaborations on workspaces, bases and interfaces associated with this enterprise account. Excludes collaborations from groups.

createdTime
optional<string>

When user was created. This field is only returned when user is internal.

descendants
optional<object>

The user's values per descendant enterprise account. Only returned when the user is on a claimed domain and the enterprise account has the Enterprise Hub feature enabled.

The below object is keyed with a string
lastActivityTime
string | null
collaborations
optional<Collaborations>
isAdmin
optional<boolean>
isManaged
optional<boolean>
groups
optional<array of the below object>
id
string

A user group ID

enterpriseUserType
optional<"accessReadOnlyShareLinks" | "full">

The type of user. Only returned if the enterprise has group mappings active and only if user is internal.

invitedToAirtableByUserId
optional<string | null>

This field is only returned when either the inviter or the user is internal. If there is no inviter, this field is null. If user is internal but inviter is external, this field is "usrEXTERNREDACTED".

isAdmin
optional<boolean>

Whether the user has directly assigned admin rights over this enterprise account. Only returned when the user is on a claimed domain. Note: if a user is a super admin but is not directly assigned admin rights over this enterprise account, this field is false.

isManaged
optional<boolean>

Whether the user is managed by this enterprise account. Only returned when the user is on a claimed domain.

isSuperAdmin
optional<boolean>

Whether the user has super admin rights over this enterprise account. Only returned when the user is on a claimed domain and the enterprise account has the Enterprise Hub feature enabled.

email
string
name
string
aggregated
optional<object>

The user's aggregated values across this enterprise account and its descendants. Only returned when the user is on a claimed domain and the enterprise account has the Enterprise Hub feature enabled.

lastActivityTime
string | null

Most recent time the user interacted with this enterprise account and its descendants' data. null if never.

collaborations
optional<Collaborations>

The user's direct collaborations on workspaces, bases and interfaces associated with this enterprise account and its descendants. Excludes collaborations from groups.

isAdmin
optional<boolean>

Whether the user has directly assigned admin rights over this enterprise account or its descendants.

groups
optional<array of the below object>

This field specifies the groups associated with this enterprise account and its descendants that the user belongs to.

id
string

A user group ID

groups
optional<array of the below object>

This field specifies the groups associated with this enterprise account that the user belongs to. This field is only returned when the user is internal.

id
string

A user group ID

Request (example)
Copy
$
curl "https://api.airtable.com/v0/meta/enterpriseAccounts/{enterpriseAccountId}/users\
?email[]=foo%40bar.com&id[]=usrsOEchC9xuwRgKk&include[]=collaborations" \
-H "Authorization: Bearer YOUR_TOKEN"
200 – Response (example)
{
"users": [
{
"collaborations": {
"baseCollaborations": [
{
"baseId": "appLkNDICXNqxSDhG",
"createdTime": "2019-01-03T12:33:12.421Z",
"grantedByUserId": "usrqccqnMB2eHylqB",
"permissionLevel": "edit"
}
],
"interfaceCollaborations": [],
"workspaceCollaborations": []
},
"createdTime": "2019-01-03T12:33:12.421Z",
"email": "baz@bar.com",
"groups": [
{
"id": "ugpR8ZT9KtIgp8Bh3"
}
],
"id": "usrsOEchC9xuwRgKk",
"invitedToAirtableByUserId": "usrGcrteE5fUMqq0R",
"isAdmin": false,
"isManaged": true,
"isServiceAccount": false,
"isSsoRequired": true,
"isTwoFactorAuthEnabled": false,
"lastActivityTime": "2019-01-03T12:33:12.421Z",
"name": "baz bar",
"state": "provisioned"
},
{
"collaborations": {
"baseCollaborations": [
{
"baseId": "appLkNDICXNqxSDhG",
"createdTime": "2019-01-03T12:33:12.421Z",
"grantedByUserId": "usrqccqnMB2eHylqB",
"permissionLevel": "edit"
}
],
"interfaceCollaborations": [
{
"baseId": "appLkNDICXNqxSDhG",
"createdTime": "2019-01-03T12:33:12.421Z",
"grantedByUserId": "usrogvSbotRtzdtZW",
"interfaceId": "pbdyGA3PsOziEHPDE",
"permissionLevel": "edit"
}
],
"workspaceCollaborations": [
{
"createdTime": "2019-01-03T12:33:12.421Z",
"grantedByUserId": "usrGcrteE5fUMqq0R",
"permissionLevel": "owner",
"workspaceId": "wspmhESAta6clCCwF"
}
]
},
"createdTime": "2019-01-03T12:33:12.421Z",
"email": "foo@bar.com",
"groups": [
{
"id": "ugp1mKGb3KXUyQfOZ"
},
{
"id": "ugpR8ZT9KtIgp8Bh3"
}
],
"id": "usrL2PNC5o3H4lBEi",
"invitedToAirtableByUserId": "usrsOEchC9xuwRgKk",
"isAdmin": true,
"isManaged": true,
"isServiceAccount": false,
"isSsoRequired": true,
"isTwoFactorAuthEnabled": false,
"lastActivityTime": "2019-01-03T12:33:12.421Z",
"name": "foo baz",
"state": "provisioned"
}
]
}