Skip to content
GET /unified/user-directory/workspaces

Partial response — use the "get" endpoint for the full object.

Query Parameters

Refer Specifying query parameters in Truto APIs

updated_atstring · date-time

Date and time when the workspace was last updated.

23 supported
Adobe Marketo Engage
supported
Asana
supported
Avalara AvaTax
supported
Contentful Content Management
supported
dbt Labs
supported
Freshservice
supported
Google CloudSQL
supported
GitLab
supported
Google
supported
Google Cloud
supported
Hashicorp Terraform Cloud
supported
Mural
supported
Pivotal Tracker
supported
Sigma Computing
supported
Teamwork Project Management
supported
Teamwork Spaces
supported
Vercel
supported
Webflow
supported
Workiva
supported
Zeplin
supported
Zesty.io
supported
Zoho BugTracker
supported
Zoho Projects
supported
organization_idstring
7 supported5 required2 notes
Cisco Meraki
required
Hashicorp Terraform Cloud
required
Mural
required

The unique identifier for the organization

Podio
required
Zoho BugTracker
required
Asana
supported

Either of organization_id or group_id is required.

Zoho Projects
supported
group_idstring

Either of organization_id or group_id is required.

1 supported
Asana
supported
statusstring

Status for the workspace

Possible values:
activeinactive
20 supported
Adobe Marketo Engage
supported
Adyen
supported
Anthropic
supported
Asana
supported
Avalara AvaTax
supported
dbt Labs
supported
Freshservice
supported
Google CloudSQL
supported
GitLab
supported
Google Ads
supported
Google Cloud
supported
Hashicorp Terraform Cloud
supported
ManageEngine ServiceDesk Plus
supported
Microsoft 365
supported
SharePoint
supported
Teamwork Project Management
supported
Teamwork Spaces
supported
Zeplin
supported
Zoho BugTracker
supported
Zoho Projects
supported
namestring

Name of the workspace.

54 supported
Adobe Marketo Engage
supported
Adyen
supported
Aha
supported
Anthropic
supported
Asana
supported
Atlassian
supported
Avalara AvaTax
supported
Bitbucket
supported
Cisco Meraki
supported
Contentful Content Management
supported
dbt Labs
supported
Discord
supported
Doppler
supported
Freshservice
supported
Google CloudSQL
supported
GitLab
supported
Gong
supported
Google
supported
Google Ads
supported
Google Cloud
supported
Hashicorp Terraform Cloud
supported
Height
supported
Highlevel
supported
Illow
supported
Jenkins
supported
Lemlist
supported
ManageEngine ServiceDesk Plus
supported
Microsoft 365
supported
Monday.com
supported
MongoDB Atlas Admin
supported
mParticle
supported
Microsoft Teams
supported
Mural
supported
Pivotal Tracker
supported
Podio
supported
Power BI
supported
Render
supported
Segment
supported
SharePoint
supported
Sigma Computing
supported
Slack Enterprise
supported
SonarQube Server
supported
Teamwork Project Management
supported
Teamwork Spaces
supported
Typeform
supported
Vercel
supported
Webflow
supported
WordPress
supported
Workiva
supported
Zeplin
supported
Zesty.io
supported
Zoho BugTracker
supported
Zoho Projects
supported
Zoho Sprints
supported
descriptionstring

Description for the workspace.

17 supported
Adobe Marketo Engage
supported
Asana
supported
Cisco Meraki
supported
Freshservice
supported
GitLab
supported
Gong
supported
Hashicorp Terraform Cloud
supported
ManageEngine ServiceDesk Plus
supported
Microsoft 365
supported
Microsoft Teams
supported
SharePoint
supported
Teamwork Project Management
supported
Teamwork Spaces
supported
Vercel
supported
WordPress
supported
Zoho BugTracker
supported
Zoho Projects
supported
sort_bystring
Possible values:
created_atnameupdated_at
3 supported
GitLab
supported
namecreated_atupdated_at
Teamwork Project Management
supported
name
Zoho Projects
supported
created_atupdated_at
workspace_idstring

When set with include_nested=true, returns all descendants of this parent group

1 supported
GitLab
supported
include_nestedboolean

Set to true to return all descendant groups (direct and indirect) of the group specified by workspace_id.

1 supported
GitLab
supported
productstring
Possible values:
analyticssharepointteams
2 supported2 required2 notes
Google
required
analytics

Select the product for which you want to retrieve the workspaces.

Microsoft 365
required
teamssharepoint

Select the product for which you want to retrieve the users.

Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

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.

Example: unified
Possible values:
unifiedrawnormalizedstream
truto_key_bystring

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.

Example: id
truto_ignore_limitboolean

Ignores the limit query parameter.

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body

next_cursorstring

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.

resultobject[]

List of Workspaces

idstring
required·

Unique identifier for the workspace.

54 supported
Adobe Marketo Engage
supported
Adyen
supported
Aha
supported
Anthropic
supported
Asana
supported
Atlassian
supported
Avalara AvaTax
supported
Bitbucket
supported
Cisco Meraki
supported
Contentful Content Management
supported
dbt Labs
supported
Discord
supported
Doppler
supported
Freshservice
supported
Google CloudSQL
supported
GitLab
supported
Gong
supported
Google
supported
Google Ads
supported
Google Cloud
supported
Hashicorp Terraform Cloud
supported
Height
supported
Highlevel
supported
Illow
supported
Jenkins
supported
Lemlist
supported
ManageEngine ServiceDesk Plus
supported
Microsoft 365
supported
Monday.com
supported
MongoDB Atlas Admin
supported
mParticle
supported
Microsoft Teams
supported
Mural
supported
Pivotal Tracker
supported
Podio
supported
Power BI
supported
Render
supported
Segment
supported
SharePoint
supported
Sigma Computing
supported
Slack Enterprise
supported
SonarQube Server
supported
Teamwork Project Management
supported
Teamwork Spaces
supported
Typeform
supported
Vercel
supported
Webflow
supported
WordPress
supported
Workiva
supported
Zeplin
supported
Zesty.io
supported
Zoho BugTracker
supported
Zoho Projects
supported
Zoho Sprints
supported
created_atstring · date-time

Date and time when the workspace was created.

34 supported
Adobe Marketo Engage
supported
Aha
supported
Anthropic
supported
Asana
supported
Avalara AvaTax
supported
Contentful Content Management
supported
dbt Labs
supported
Freshservice
supported
Google CloudSQL
supported
GitLab
supported
Google
supported
Google Cloud
supported
Hashicorp Terraform Cloud
supported
Height
supported
Highlevel
supported
Lemlist
supported
ManageEngine ServiceDesk Plus
supported
Microsoft 365
supported
Monday.com
supported
MongoDB Atlas Admin
supported
mParticle
supported
Mural
supported
Pivotal Tracker
supported
SharePoint
supported
Sigma Computing
supported
Teamwork Project Management
supported
Teamwork Spaces
supported
Vercel
supported
Webflow
supported
Workiva
supported
Zeplin
supported
Zesty.io
supported
Zoho BugTracker
supported
Zoho Projects
supported
descriptionstring

Description for the workspace.

17 supported
Adobe Marketo Engage
supported
Asana
supported
Cisco Meraki
supported
Freshservice
supported
GitLab
supported
Gong
supported
Hashicorp Terraform Cloud
supported
ManageEngine ServiceDesk Plus
supported
Microsoft 365
supported
Microsoft Teams
supported
SharePoint
supported
Teamwork Project Management
supported
Teamwork Spaces
supported
Vercel
supported
WordPress
supported
Zoho BugTracker
supported
Zoho Projects
supported
namestring

Name of the workspace.

54 supported
Adobe Marketo Engage
supported
Adyen
supported
Aha
supported
Anthropic
supported
Asana
supported
Atlassian
supported
Avalara AvaTax
supported
Bitbucket
supported
Cisco Meraki
supported
Contentful Content Management
supported
dbt Labs
supported
Discord
supported
Doppler
supported
Freshservice
supported
Google CloudSQL
supported
GitLab
supported
Gong
supported
Google
supported
Google Ads
supported
Google Cloud
supported
Hashicorp Terraform Cloud
supported
Height
supported
Highlevel
supported
Illow
supported
Jenkins
supported
Lemlist
supported
ManageEngine ServiceDesk Plus
supported
Microsoft 365
supported
Monday.com
supported
MongoDB Atlas Admin
supported
mParticle
supported
Microsoft Teams
supported
Mural
supported
Pivotal Tracker
supported
Podio
supported
Power BI
supported
Render
supported
Segment
supported
SharePoint
supported
Sigma Computing
supported
Slack Enterprise
supported
SonarQube Server
supported
Teamwork Project Management
supported
Teamwork Spaces
supported
Typeform
supported
Vercel
supported
Webflow
supported
WordPress
supported
Workiva
supported
Zeplin
supported
Zesty.io
supported
Zoho BugTracker
supported
Zoho Projects
supported
Zoho Sprints
supported
organizationobject

organization associated with the workspace

12 supported
Asana
supported
Atlassian
supported
Avalara AvaTax
supported
Cisco Meraki
supported
GitLab
supported
Hashicorp Terraform Cloud
supported
MongoDB Atlas Admin
supported
Mural
supported
Podio
supported
Workiva
supported
Zeplin
supported
Zesty.io
supported
2 properties
idstring

The unique identifier for an organization

namestring

The name of the organization

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

Status for the workspace

Possible values:
activeinactive
20 supported
Adobe Marketo Engage
supported
Adyen
supported
Anthropic
supported
Asana
supported
Avalara AvaTax
supported
dbt Labs
supported
Freshservice
supported
Google CloudSQL
supported
GitLab
supported
Google Ads
supported
Google Cloud
supported
Hashicorp Terraform Cloud
supported
ManageEngine ServiceDesk Plus
supported
Microsoft 365
supported
SharePoint
supported
Teamwork Project Management
supported
Teamwork Spaces
supported
Zeplin
supported
Zoho BugTracker
supported
Zoho Projects
supported
updated_atstring · date-time

Date and time when the workspace was last updated.

23 supported
Adobe Marketo Engage
supported
Asana
supported
Avalara AvaTax
supported
Contentful Content Management
supported
dbt Labs
supported
Freshservice
supported
Google CloudSQL
supported
GitLab
supported
Google
supported
Google Cloud
supported
Hashicorp Terraform Cloud
supported
Mural
supported
Pivotal Tracker
supported
Sigma Computing
supported
Teamwork Project Management
supported
Teamwork Spaces
supported
Vercel
supported
Webflow
supported
Workiva
supported
Zeplin
supported
Zesty.io
supported
Zoho BugTracker
supported
Zoho Projects
supported
curl -X GET 'https://api.truto.one/unified/user-directory/workspaces?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const integratedAccountId = '<integrated_account_id>';

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

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

url = "https://api.truto.one/unified/user-directory/workspaces"
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())
import Truto from '@truto/truto-ts-sdk';

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

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

console.log(result);
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",
        "workspaces",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())