Skip to main content
GET
/
scim
/
v2
/
Users
List SCIM users
curl --request GET \
  --url https://api.attio.com/scim/v2/Users \
  --header 'Authorization: <authorization>'
{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 1,
  "Resources": [
    {
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
      "id": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
      "userName": "john.doe@example.com",
      "name": {
        "givenName": "John",
        "familyName": "Doe"
      },
      "emails": [
        {
          "value": "john.doe@example.com",
          "primary": true
        }
      ],
      "active": true,
      "appRole": "member",
      "meta": {
        "resourceType": "User",
        "created": "2024-01-01T00:00:00.000Z",
        "lastModified": "2024-01-01T00:00:00.000Z"
      }
    }
  ]
}

​
Authorizations

​
Authorization
string
required
This API uses OAuth 2.0 with the authorization code grant flow.

​
Query

​
filter
string
A SCIM filter expression. Supported attributes: userName, emails.value. Example: userName eq "john@example.com".
​
startIndex
integer
default:"1"
1-based index of the first result to return.
​
count
integer
Maximum number of results to return. Capped at 100.

​
Response

​
schemas
string[]
Always ["urn:ietf:params:scim:api:messages:2.0:ListResponse"].
​
totalResults
integer
Total number of users matching the filter.
​
startIndex
integer
The 1-based index of the first result returned.
​
itemsPerPage
integer
The number of results returned in this page.
​
Resources
object[]
The list of users. Each user has the same shape as the Get a SCIM user response.
{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 1,
  "Resources": [
    {
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
      "id": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
      "userName": "john.doe@example.com",
      "name": {
        "givenName": "John",
        "familyName": "Doe"
      },
      "emails": [
        {
          "value": "john.doe@example.com",
          "primary": true
        }
      ],
      "active": true,
      "appRole": "member",
      "meta": {
        "resourceType": "User",
        "created": "2024-01-01T00:00:00.000Z",
        "lastModified": "2024-01-01T00:00:00.000Z"
      }
    }
  ]
}