Web API

Press shift + S to search API reference.

User groups

Get user group

gethttps://api.airtable.com/v0/meta/groups/{groupId}

Returns basic information relevant to the user group.

Requirements

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

Enterprise member

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

Path parameters

groupId
string

Query parameters

include
optional<array of "collaborations">

If specified, collaborations key will be included in the response object. Otherwise it will be left out. You must be a group member or enterprise admin to view this information.

Response format

id
string

A user group ID

createdTime
string

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

enterpriseAccountId
string

The id of the enterprise account that the group is associated with.

updatedTime
string

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

collaborations
optional<Collaborations>

The group's direct collaborations on workspaces, bases and interfaces.

name
string
members
array of the below object

Group members' information.

createdTime
string

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

userId
string

A user ID

email
string
firstName
string | null
lastName
string | null
role
"manager" | "member"
Request (example)
Copy
$
curl "https://api.airtable.com/v0/meta/groups/{groupId}" \
-H "Authorization: Bearer YOUR_TOKEN"
200 – Response (example)
{
"collaborations": {
"baseCollaborations": [
{
"baseId": "appLkNDICXNqxSDhG",
"createdTime": "2021-06-02T07:37:50.000Z",
"grantedByUserId": "usrogvSbotRtzdtZW",
"permissionLevel": "create"
}
],
"interfaceCollaborations": [
{
"baseId": "appLkNDICXNqxSDhG",
"createdTime": "2019-01-03T12:33:12.421Z",
"grantedByUserId": "usrqccqnMB2eHylqB",
"interfaceId": "pbdyGA3PsOziEHPDE",
"permissionLevel": "edit"
}
],
"workspaceCollaborations": [
{
"createdTime": "2021-06-02T07:37:48.000Z",
"grantedByUserId": "usrqccqnMB2eHylqB",
"permissionLevel": "edit",
"workspaceId": "wspmhESAta6clCCwF"
}
]
},
"createdTime": "2021-06-02T07:37:19.000Z",
"enterpriseAccountId": "entUBq2RGdihxl3vU",
"id": "ugp1mKGb3KXUyQfOZ",
"members": [
{
"createdTime": "2021-06-02T07:37:19.000Z",
"email": "foo@bar.com",
"firstName": "Jane",
"lastName": "Doe",
"role": "member",
"userId": "usrL2PNC5o3H4lBEi"
},
{
"createdTime": "2021-06-02T07:37:19.000Z",
"email": "foo@bam.com",
"firstName": "Alex",
"lastName": "Hay",
"role": "manager",
"userId": "usrsOEchC9xuwRgKk"
},
{
"createdTime": "2021-06-02T07:37:19.000Z",
"email": "bam@bam.com",
"firstName": "John",
"lastName": "Dane",
"role": "member",
"userId": "usrGcrteE5fUMqq0R"
}
],
"name": "Group name",
"updatedTime": "2022-09-02T10:10:35:000Z"
}