Web API

Press shift + S to search API reference.

SCIM

List groups

gethttps://airtable.com/scim/v2/Groups

List groups as SCIM Groups objects. SCIM specification for list responses.

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

Query parameters

count
optional<number>

Number of groups to return, defaults to all groups.

filter
optional<string>

The SCIM spec includes additional filter options, but we only support equality filtering by the Group display name, which is the SCIM displayName.

Response format

schemas
array of strings
startIndex
number

Position of the first result from the full list of groups, starting from 1, defaults to 1.

itemsPerPage
number
totalResults
number
Resources
array of the below object
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.

Request (example)
Copy
$
curl "https://airtable.com/scim/v2/Groups" \
-H "Authorization: Bearer YOUR_TOKEN"
200 – Response (example)
{
"Resources": [
{
"displayName": "ExampleGroup",
"id": "ugpQ7PJ2boxzMAKFU",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
]
}
],
"itemsPerPage": 1,
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"startIndex": 1,
"totalResults": 1
}