# List Users

> Source: https://truto.one/docs/api-reference/unified-user-directory-api/users/list/

`GET /unified/user-directory/users`

Resource: **Users** · API: **Unified User Directory API**

## Supported integrations

, 15Five (partial), Accelo, ActiveCampaign (partial), Adaptive, Adobe, Adobe Marketo Engage (partial), Adobe Acrobat Sign (partial), Adyen, Aha, Aircall, Airtable (partial), Airtable SCIM, Amplitude SCIM, Anthropic, Apache Airflow, Apollo, Apono, Asana (partial), Asset Panda, Atlassian, Attio, Auth0, Avalara AvaTax, Avigilon Alta (partial), Avoma, Azure Active Directory, BambooHR, Baremetrics, Basecamp, BigPanda, Bitbucket, Bitwarden, BlackLine (partial), Boomi, Box, Braze, Brex, Britive, BrowserStack, Buildkite, Calendly (partial), Canva, Capsule, Cato Networks, Checkr, Chronosphere, Cisco Meraki, ClickUp, Close, Cloudflare, CockroachDB Cloud (partial), Coda, Concord, Confluence (partial), Confluence On Prem  (partial), Confluent (partial), Constant Contact, Contentful Content Management, Copper, Coupa, CrowdStrike (partial), CyberArk (partial), CyberArk Identity Management (partial), Dashlane, Databricks, Datadog (partial), dbt Labs, DevRev, Dialpad, Discord, Dixa (partial), Docker Hub SCIM, DocuSign (partial), Domo, Doppler, Drata, Drift (partial), Dropbox - Business (partial), Druva inSync (partial), Duo, Microsoft Dynamics 365 Sales, Dynatrace, Egnyte, Elastic Cloud, Emburse, Enchant, Envoy, Eventbrite, Figma SCIM, Files.com, Fireberry, Fireflies.ai, Fivetran, FloQast, Fountain, FowCRM, FreeAgent, Freshcaller, Freshchat, Freshdesk (partial), Freshsales, Freshservice, Front, FuseDesk, Google CloudSQL, GitHub (partial), GitLab, Gladly, Gong, Google, Google Ads, Google Analytics, Google Cloud (partial), Google Workspace, Gorgias, Grafana, Greenhouse, HaloITSM (partial), HappyFox, Harness, Harvest, Hashicorp Terraform Cloud, Height, HelloID, Dropbox Sign (HelloSign), Help Scout, Heroku, HiBob, Highlevel, Hive, Hootsuite (partial), HubSpot (partial), Humaans, Illow, Insightly, Intercom, Ironclad, Jamf (partial), Jenkins, Jetbrains, JFrog (partial), Jira (partial), Jira Service Management (partial), Jostle SCIM, JumpCloud (partial), juniper-mist, Juniper Mist, JustCall, Kandji, Keap, Keeper , KnowBe4, KnowBe4 SCIM, Kommo, Kustomer, LastPass, Lattice, LaunchDarkly, Leadsquared (partial), LearnWorlds, Lemlist (partial), Lever, Linear, LiveAgent (partial), LoanPro, Looker (partial), Loxo, Lucid, Mailersend, Mailgun, Make, ManageEngine ServiceDesk Plus (partial), Manatal, Metabase, Meta Marketing API, Microsoft 365, miniOrange, Miro, Miro SCIM, Missive, Mixpanel SCIM, Mode (partial), Monday.com, Monday.com SCIM, Moneybird, MongoDB Atlas Admin, mParticle, Microsoft Dynamics 365 Finance and Operations, Microsoft Teams, Mural, Netlify, Netskope SCIM, Oracle Netsuite, New Relic, Ninjaone, Notion, Notion SCIM, Nutshell, Okta (partial), OneDrive, OneLogin, OnePageCRM, OpenAI, OpenVPN CloudConnexa, Opsgenie (partial), Oracle Fusion Cloud, Oracle Fusion Cloud EPM (partial), Oracle Fusion Cloud Financials, Orca Security, Outlook Mail, Outlook Calendar, Outreach (partial), PagerDuty (partial), PandaDoc, Paralus, Peakon SCIM, Pendo SCIM, PingOne, Pinpoint, Pipedrive, Pipeline CRM, Pipeliner, Pivotal Tracker, Plaid, Platform.sh (partial), Podio, Podium, PostHog, Postman SCIM, Power BI, ProdPad, Puzzel Case Management, Pylon, Qdrant Cloud (partial), Qlik Sense, Qualtrics CoreXM (partial), Quickbase for Project Management, Re:amaze, Redis, Render, Retool, Richpanel, Rippling, Rithum, Robin, Rockset, Rollbar (partial), Rootly (partial), Sage Intacct (partial), SailPoint IdentityIQ SCIM, SailPoint Identity Security Cloud (partial), SailPoint NERM (partial), Salesflare, Salesforce (partial), Salesloft, SAP Concur, Scale AI, Segment, Seismic, SendGrid, Sendoso, Sentry, ServiceNow, ServiceNow SCIM, SharePoint, Shopify, Shortcut, Showpad, Sigma Computing, Sisense, Slab, Slack, Slack Enterprise (partial), SmartRecruiters, Smartsheet, Snowflake, Snyk, SolarWinds Service Desk, SonarQube Cloud, SonarQube Server, Sophos, SpotDraft, Statsig, Streak (partial), Sumo Logic, Supabase, Superchat, Survey Monkey (partial), SurveySparrow, Tableau, Tailscale, TalentLMS (partial), TalentLyft, Talkdesk, Teamleader, TeamViewer (partial), Teamwork CRM, Teamwork Desk, Teamwork Project Management, Teamwork Spaces, Tenable (partial), ThoughtSpot, Torii, travelperk, Trello (partial), Trengo, Truto Test, Turso, Twingate, Typeform, UiPath, UserVoice, Vanta, Veeva Vault, Vercel, Vidyard, Wealthbox, Webex, Webflow, Wingman, Wiz, WordPress, Workato, Workiva, Wrike, Xero, YouTrack, Youtrack Hub, Zapier SCIM, Zendesk, Zendesk Sell, Zeplin, Zesty.io, Zoho Analytics, Zoho Bigin, Zoho Books (partial), Zoho BugTracker, Zoho CRM, Zoho Desk, Zoho Meeting, Zoho Projects (partial), Zoho Sprints, Zoho Vault, Zoom, ZoomInfo SCIM, Zscaler, Zscaler ZIA, Zscaler ZPA SCIM

## Query parameters

- **`integrated_account_id`** _(string, required)_
  The ID of the integrated account to use for the request.
- **`truto_response_format`** _(string)_
  The format of the response. - `unified` returns the response with unified mappings applied. - `raw` returns the unprocessed, raw response from the remote API. - `normalized` applies the unified mappings and returns the data in a normalized format. - `stream` returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory. Defaults to `unified`.
  Allowed: `unified`, `raw`, `normalized`, `stream`
- **`truto_key_by`** _(string)_
  By default the `result` attribute is an array of objects. This parameter allows you to specify a field in each `result` objects to use as key, which transforms the `result` array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
- **`truto_ignore_limit`** _(boolean)_
  Ignores the `limit` query parameter.
- **`truto_ignore_remote_data`** _(boolean)_
  Excludes the `remote_data` attribute from the response.
- **`truto_exclude_fields`** _(array<string>)_
  Array of fields to exclude from the response.
- **`remote_query`** _(object)_
  Query parameters to pass to the underlying API without any transformations. Refer [this guide](https://truto.one/docs/api-reference/overview/querying#remote-query-parameters) to see how to structure the query parameters.
- **`first_name`** _(string)_
  The first name of the user
- **`last_name`** _(string)_
  The last name of the user
- **`emails`** _(array<object>)_
  The emails of the user
- **`status`** _(string)_
  The status of the user. If no clear mapping is available, then the raw value is returned.
  Allowed: `active`, `created`, `deleted`, `inactive`, `invited`
- **`created_at`** _(string)_
  The date and time the user was created
- **`updated_at`** _(string)_
  The date and time the user was last updated
- **`sort_by`** _(string)_
  The possible fieldName are id, username, urls, emails.
  Allowed: `created_at`, `emails`, `first_name`, `groups`, `id`, `last_active_at`, `last_login_at`, `name`, `roles`, `status`, `updated_at`, `username`
- **`group_id`** _(string)_
- **`workspace_id`** _(string)_
- **`organization_id`** _(string)_
- **`name`** _(string)_
  The name of the user
- **`include_last_login_at`** _(boolean)_
- **`role_id`** _(string)_
  The unique identifier for a role.
- **`email`** _(string)_
  The email of the user
- **`username`** _(string)_
  The username of the user
- **`include_inherited`** _(boolean)_
  If true (and using a group/workspace context), include inherited members.
- **`roles`** _(array<object>)_
  The roles of the user
- **`product`** _(string)_
  Select the product for which you want to retrieve the users.
  Allowed: `analytics`, `azure_active_directory`, `onedrive`, `sharepoint`, `teams`, `workspace`
- **`customer_id`** _(string)_
  The unique identifier of the customer.
- **`org_unit_path`** _(string)_
  The full path of an org unit.
- **`user_type`** _(string)_
  The type of user
  Allowed: `admin`, `end_user`, `limited`, `machine`, `user`
- **`org_id`** _(string)_
- **`groups`** _(array<object>)_
  The groups of the user
- **`title`** _(string)_
  The title of the user

## Response body

- **`result`** _(array<object>)_
  List of Users
  - **`id`** _(string, required)_
    The unique identifier for a user
  - **`external_id`** _(string)_
    The external identifier for a user. This is set when the SCIM API is being used.
  - **`identifiers`** _(object)_
    The identifiers of the user.
  - **`first_name`** _(string)_
    The first name of the user
  - **`last_name`** _(string)_
    The last name of the user
  - **`title`** _(string)_
    The title of the user
  - **`name`** _(string)_
    The name of the user
  - **`username`** _(string)_
    The username of the user
  - **`emails`** _(array<object>)_
    The emails of the user
    - **`email`** _(string)_
      The email address
    - **`type`** _(string)_
      The type of email address
    - **`is_primary`** _(boolean)_
      Whether the email address is primary
  - **`phones`** _(array<object>)_
    The phones of the user
    - **`number`** _(string)_
      The phone number
    - **`extension`** _(string)_
      The extension of the phone number
    - **`type`** _(string)_
      The type of phone number
  - **`status`** _(string)_
    The status of the user. If no clear mapping is available, then the raw value is returned.
    Allowed: `active`, `inactive`, `deleted`, `invited`
  - **`is_email_verified`** _(boolean)_
    Whether the user's email has been verified
  - **`is_2fa_enabled`** _(boolean)_
    Whether the user has 2FA enabled
  - **`roles`** _(array<object>)_
    The roles of the user
    - **`id`** _(string)_
      The unique identifier for a role
    - **`name`** _(string)_
      The name of the role
    - **`group`** _(string)_
      The role of the user in the group. This is available when the user can have different roles in different groups or teams in an application.
    - **`organization`** _(string)_
      The role of the user in the organization. This is available when the user can have different roles in different organizations in an application.
    - **`workspace`** _(string)_
      The role of the user in the workspace. This is available when the user can have different roles in different workspaces in an application.
  - **`organizations`** _(array<object>)_
    The organizations of the user
    - **`id`** _(string)_
      The unique identifier for an organization
    - **`name`** _(string)_
      The name of the organization
  - **`user_type`** _(string)_
    The type of user
  - **`licenses`** _(array<object>)_
    The licenses of the user or the products the user has access to
    - **`id`** _(string)_
      The unique identifier for a license
    - **`name`** _(string)_
      The name of the license
    - **`organization`** _(string)_
      The unique identifier of the organization to which the license belongs
    - **`last_active_at`** _(string)_
      The date and time the user was last active for the license
  - **`groups`** _(array<object>)_
    The groups of the user
    - **`id`** _(string)_
      The unique identifier for a group
    - **`name`** _(string)_
      The name of the group
    - **`organization`** _(string)_
      The unique identifier of the organization to which the group belongs
  - **`workspaces`** _(array<object>)_
    The workspaces of the user
    - **`id`** _(string)_
      The unique identifier for a workspace
    - **`name`** _(string)_
      The name of the workspaces
  - **`avatar`** _(string)_
    The avatar of the user
  - **`timezone`** _(string)_
    The timezone of the user
  - **`languages`** _(array<string>)_
    The languages preferred by the user
  - **`bio`** _(string)_
    The bio of the user. Usually a short description set by the user about them.
  - **`created_at`** _(string)_
    The date and time the user was created
  - **`updated_at`** _(string)_
    The date and time the user was last updated
  - **`last_active_at`** _(string)_
    The date and time the user was last active
  - **`last_login_at`** _(string)_
    The date and time the user was last logged in
  - **`status_changed_at`** _(string)_
    The date and time the user's status was last changed
  - **`activated_at`** _(string)_
    The date and time the user was activated
  - **`urls`** _(array<object>)_
    The URLs of the user
    - **`url`** _(string)_
      The URL
    - **`type`** _(string)_
      The type of URL
  - **`remote_data`** _(object)_
    Raw data returned from the remote API call.
- **`next_cursor`** _(string)_
  The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.

## Code examples

### curl

```bash
curl -X GET 'https://api.truto.one/unified/user-directory/users?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
```

### JavaScript

```javascript
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/user-directory/users?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
```

### Python

```python
import requests

url = "https://api.truto.one/unified/user-directory/users"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
```

### Truto TS SDK

```typescript
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.list(
  'user-directory',
  'users',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
```

### Truto Python SDK

```python
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    async for item in truto_api.unified_api.list(
        "user-directory",
        "users",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())
```