Web API

Press shift + S to search API reference.

SCIM

Get group

gethttps://airtable.com/scim/v2/Groups/{groupId}

Get a single group as a SCIM Group object.

Requirements

AuthenticationPersonal access token, OAuth integration
Scopeenterprise.scim.usersAndGroups:manage
User role

Enterprise admin

Admins of multiple enterprises should use a service account's token when calling this route.
Billing plansEnterprise (pre-2023.08 legacy plan), Enterprise Scale

Path parameters

groupId
string

Response format

id
string

A user group ID

schemas
array of strings

A list of schemas, including at least SCIM's core group schema URI.

displayName
string | null

Becomes the displayName of the group in Airtable. It must not be in use already.

members
optional<array of the below object>

List of members of the group.

value
string

Represents the user ID of a group member

Error responses

Unknown group ID (400)
With an unknown Group ID
{
"detail": "invalid group ID",
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"status": 400
}
Request (example)
Copy
$
curl "https://airtable.com/scim/v2/Groups/{groupId}" \
-H "Authorization: Bearer YOUR_TOKEN"
200 – Response (example)
{
"displayName": "ExampleGroup",
"id": "ugpQ7PJ2boxzMAKFU",
"members": [
{
"value": "usrI7HMkO7sAefUHk"
},
{
"value": "usrM4UuTPOjRlDOHT"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
]
}