---
title: "List users"
url: "https://docs.unified.to/scim/users/List_users"
description: "API reference for List users. Launch multiple pre-built Users integrations today with zero maintenance — all through a single API."
generated_at: "2026-05-27T21:04:48.846Z"
---
# List users

 GET/scim/{connection\_id}/users

## Parameters

**filter**string 

**sortBy**string 

**sortOrder**string 

**startIndex**number 

**count**number 

**connection\_id**string  required 

ID of the connection

## Returns

[ScimUser](/scim/user/model)array

**id**string 

**schemas** enum array 

Valid values:

 "urn:ietf:params:scim:schemas:core:2.0:User" 

 "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User" 

 "urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User" 

 "urn:ietf:params:scim:schemas:extension:peakon:2.0:User" 

**externalId**string 

**userType**string 

'Employee','Super Admin', 'General Admin', 'Account Manager', 'User Manager', 'Workflow Manager', 'Experience Manager', 'Author','Reporter','Contractor,'Intern','Temp','External','Unknown'\]

**userName**string 

**meta**object 

**name**object 

**displayName**string 

**nickName**string 

**profileUrl**string 

**title**string 

**preferredLanguage**string 

**locale**string 

**timezone**string 

**active**boolean 

**password**string 

**phoneNumbers** array 

**emails** array 

**ims** array 

**photos** array 

**addresses** array 

**groups** array 

**entitlements** array 

**roles** array 

Student, Faculty, ...

**x509Certificates** array 

**urn\_ietf\_params\_scim\_schemas\_extension\_enterprise\_2\_0\_User**object 

an organization.

**urn\_ietf\_params\_scim\_schemas\_extension\_lattice\_attributes\_1\_0\_User**object 

**urn\_ietf\_params\_scim\_schemas\_extension\_peakon\_2\_0\_User**object 

## Code Samples

### Node.js SDK

```
import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const results = await sdk.scim.listScimUsers({ connectionId, 
    filter: '',
    sortBy: '',
    sortOrder: '',
    startIndex: '',
    count: '',
 });
```

### Node.js (axios)

```
const options = {
  method: 'GET',
  url: 'https://api.unified.to/scim/5de520f96e439b002043d8dc/users',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    filter: '',
    sortBy: '',
    sortOrder: '',
    startIndex: '',
    count: '',
  }
};

const results = await axios.request(options);
```

### Java

```
AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/scim/5de520f96e439b002043d8dc/users?filter=&sortBy=&sortOrder=&startIndex=&count=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();
```

### Go

```
import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/scim/5de520f96e439b002043d8dc/users?filter=&sortBy=&sortOrder=&startIndex=&count=

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
```

### Python

```
import requests

url = "https://api.unified.to/scim/5de520f96e439b002043d8dc/users?filter=&sortBy=&sortOrder=&startIndex=&count="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.get(url, headers=headers)
```

### PHP

```
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/scim/5de520f96e439b002043d8dc/users?filter=&sortBy=&sortOrder=&startIndex=&count=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);
```

### Ruby

```
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/scim/5de520f96e439b002043d8dc/users?filter=&sortBy=&sortOrder=&startIndex=&count=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body
```

### cURL

```
curl --request GET \
  --url 'https://api.unified.to/scim/5de520f96e439b002043d8dc/users?filter=&sortBy=&sortOrder=&startIndex=&count=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'
```