Web API

Press shift + S to search API reference.

SCIM

Get user

gethttps://airtable.com/scim/v2/Users/{userId}

Get a single user as a SCIM User 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 plansBusiness, Enterprise (pre-2023.08 legacy plan), Enterprise Scale

Path parameters

userId
string

Response format

SCIM user schema

Error responses

Unknown user Id (404)
With an unknown user ID
{
"detail": "not a valid userId",
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"status": 404
}
Request (example)
Copy
$
curl "https://airtable.com/scim/v2/Users/{userId}" \
-H "Authorization: Bearer YOUR_TOKEN"
200 – Response (example)
{
"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"
}