List SCIM groups
curl --request GET \
--url https://api.attio.com/scim/v2/Groups \
--header 'Authorization: <authorization>'import requests
url = "https://api.attio.com/scim/v2/Groups"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.attio.com/scim/v2/Groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.attio.com/scim/v2/Groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.attio.com/scim/v2/Groups"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.attio.com/scim/v2/Groups")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.attio.com/scim/v2/Groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 2,
"startIndex": 1,
"itemsPerPage": 2,
"Resources": [
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"id": "b5d3f8a1-c920-47e6-8b4d-3f17a9c82e50",
"displayName": "Engineering",
"members": [
{
"value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
"$ref": "/scim/v2/Users/3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"
}
],
"meta": {
"resourceType": "Group",
"created": "2024-01-01T00:00:00.000Z",
"lastModified": "2024-01-01T00:00:00.000Z"
}
}
]
}
Groups
List SCIM groups
Lists all SCIM groups in the workspace, with optional filtering and pagination.
Required scopes: user_management:read.
GET
/
scim
/
v2
/
Groups
List SCIM groups
curl --request GET \
--url https://api.attio.com/scim/v2/Groups \
--header 'Authorization: <authorization>'import requests
url = "https://api.attio.com/scim/v2/Groups"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.attio.com/scim/v2/Groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.attio.com/scim/v2/Groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.attio.com/scim/v2/Groups"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.attio.com/scim/v2/Groups")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.attio.com/scim/v2/Groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 2,
"startIndex": 1,
"itemsPerPage": 2,
"Resources": [
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"id": "b5d3f8a1-c920-47e6-8b4d-3f17a9c82e50",
"displayName": "Engineering",
"members": [
{
"value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
"$ref": "/scim/v2/Users/3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"
}
],
"meta": {
"resourceType": "Group",
"created": "2024-01-01T00:00:00.000Z",
"lastModified": "2024-01-01T00:00:00.000Z"
}
}
]
}
Authorizations
string
required
This API uses OAuth 2.0 with the authorization code grant flow.
Query
string
A SCIM filter expression. Supported attributes:
displayName. Example: displayName eq "Engineering".integer
default:"1"
1-based index of the first result to return.
integer
Maximum number of results to return. Capped at 100.
string
Comma-separated list of attributes to exclude from results. Supports
"members" to omit the members array for efficiency.Response
string[]
Always
["urn:ietf:params:scim:api:messages:2.0:ListResponse"].integer
Total number of groups matching the filter.
integer
The 1-based index of the first result returned.
integer
The number of results returned in this page.
object[]
The list of groups. Each group has the same shape as the Get a SCIM group response. When
excludedAttributes=members is specified, the members field is omitted entirely from each group object.{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 2,
"startIndex": 1,
"itemsPerPage": 2,
"Resources": [
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"id": "b5d3f8a1-c920-47e6-8b4d-3f17a9c82e50",
"displayName": "Engineering",
"members": [
{
"value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
"$ref": "/scim/v2/Users/3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"
}
],
"meta": {
"resourceType": "Group",
"created": "2024-01-01T00:00:00.000Z",
"lastModified": "2024-01-01T00:00:00.000Z"
}
}
]
}
Was this page helpful?
⌘I