Web API

Press shift + S to search API reference.

SCIM

List users

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

List users as SCIM User objects.

See the SCIM specification for list responses for more.

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 plansBusiness, Enterprise (pre-2023.08 legacy plan), Enterprise Scale

Query parameters

startIndex
optional<number>

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

count
optional<number>

Number of users to return, defaults to all users.

filter
optional<string>

The SCIM spec includes additional filter options, but we only support equality filtering by the Airtable user email, which is the SCIM user name.

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 SCIM user schemas
Request (example)
Copy
$
curl "https://airtable.com/scim/v2/Users" \
-H "Authorization: Bearer YOUR_TOKEN"
200 – Response (example)
{
"Resources": [
{
"active": true,
"id": "usrogvSbotRtzdtZW",
"meta": {
"created": "2021-06-02T07:37:19.000Z",
"location": "/scim/v2/Users/usr00000000000000",
"resourceType": "User"
},
"name": {
"familyName": "Jane",
"givenName": "Doe"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"userName": "foo@bar.com"
}
],
"itemsPerPage": 1,
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"startIndex": 2,
"totalResults": 3
}