Appearance

List Workspaces ​

Endpoint ​

http
GET /unified/user-directory/workspaces
Integrations supported
  • Adobe Marketo Engage
  • Adyen
  • Aha
  • Anthropic
  • Asana
  • Bitbucket
  • Cisco Meraki
  • Contentful Content Management
  • dbt Labs
  • Discord
  • Doppler
  • Freshservice
  • Google CloudSQL
  • GitLab
  • Gong
  • Google
  • Google Ads
  • Google Cloud
  • Hashicorp Terraform Cloud
  • Height
  • Highlevel
  • Illow
  • Jenkins
  • Lemlist
  • ManageEngine ServiceDesk Plus
  • Microsoft 365
  • Monday.com
  • MongoDB Atlas Admin
  • Microsoft Teams
  • Mural
  • Pivotal Tracker
  • Podio
  • Power BI
  • Render
  • Segment
  • SharePoint
  • Sigma Computing
  • Slack Enterprise
  • SonarQube Server
  • Teamwork Project Management
  • Teamwork Spaces
  • Typeform
  • Vercel
  • Webflow
  • WordPress
  • Zeplin
  • Zoho BugTracker
  • Zoho Projects
  • Zoho Sprints
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • Aha
  • Bitbucket
  • Podio

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
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.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
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.

Example: id
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

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

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
organization_id
string
Integration specific notes
  • MuralThe unique identifier for the organization
  • AsanaEither of organization_id or group_id is required.
Required in
  • Cisco Meraki
  • Hashicorp Terraform Cloud
  • Mural
  • Podio
  • Zoho BugTracker
Supported in
  • Asana
  • Zoho Projects
name
string

Name of the workspace.

Supported in
  • GitLab
  • Render
  • Sigma Computing
  • Teamwork Project Management
status
string

Status for the workspace

All possible enum values:
  • active
  • inactive
Supported in
  • GitLab
  • Teamwork Project Management
  • Zoho Projects
updated_at
string · date-time

Date and time when the workspace was last updated.

Supported in
  • Aha
  • Teamwork Project Management
  • Zoho Projects
sort_by
string

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

All possible enum values:
  • created_at
  • name
  • updated_at
Enum support by integration
  • Teamwork Project Management
    • name
  • GitLab
    • name
    • created_at
    • updated_at
  • Zoho Projects
    • created_at
    • updated_at
Supported in
  • GitLab
  • Teamwork Project Management
  • Zoho Projects
description
string

Description for the workspace.

Supported in
  • GitLab
workspace_id
string

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

Supported in
  • GitLab
include_nested
boolean

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

Supported in
  • GitLab
group_id
string

Either of organization_id or group_id is required.

Supported in
  • Asana
product
string
Integration specific notes
  • GoogleSelect the product for which you want to retrieve the workspaces.
  • Microsoft 365Select the product for which you want to retrieve the users.
All possible enum values:
  • analytics
  • sharepoint
  • teams
Enum support by integration
  • Google
    • analytics
  • Microsoft 365
    • teams
    • sharepoint
Required in
  • Google
  • Microsoft 365

Response Body ​

result
object[]

List of Workspaces

id
string
REQUIRED · 

Unique identifier for the workspace.

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

Name of the workspace.

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

Description for the workspace.

Supported in
  • Adobe Marketo Engage
  • Asana
  • Cisco Meraki
  • Freshservice
  • GitLab
  • Gong
  • Hashicorp Terraform Cloud
  • ManageEngine ServiceDesk Plus
  • Microsoft 365
  • Microsoft Teams
  • SharePoint
  • Teamwork Project Management
  • Teamwork Spaces
  • Vercel
  • WordPress
  • Zoho BugTracker
  • Zoho Projects
status
string

Status for the workspace

All possible enum values:
  • active
  • inactive
Supported in
  • Adobe Marketo Engage
  • Adyen
  • Anthropic
  • Asana
  • dbt Labs
  • Freshservice
  • Google CloudSQL
  • GitLab
  • Google Ads
  • Google Cloud
  • Hashicorp Terraform Cloud
  • ManageEngine ServiceDesk Plus
  • Microsoft 365
  • SharePoint
  • Teamwork Project Management
  • Teamwork Spaces
  • Zeplin
  • Zoho BugTracker
  • Zoho Projects
created_at
string · date-time

Date and time when the workspace was created.

Supported in
  • Adobe Marketo Engage
  • Aha
  • Anthropic
  • Asana
  • Contentful Content Management
  • dbt Labs
  • Freshservice
  • Google CloudSQL
  • GitLab
  • Google
  • Google Cloud
  • Hashicorp Terraform Cloud
  • Height
  • Highlevel
  • Lemlist
  • ManageEngine ServiceDesk Plus
  • Microsoft 365
  • Monday.com
  • MongoDB Atlas Admin
  • Mural
  • Pivotal Tracker
  • SharePoint
  • Sigma Computing
  • Teamwork Project Management
  • Teamwork Spaces
  • Vercel
  • Webflow
  • Zeplin
  • Zoho BugTracker
  • Zoho Projects
updated_at
string · date-time

Date and time when the workspace was last updated.

Supported in
  • Adobe Marketo Engage
  • Asana
  • Contentful Content Management
  • dbt Labs
  • Freshservice
  • Google CloudSQL
  • GitLab
  • Google
  • Google Cloud
  • Hashicorp Terraform Cloud
  • Mural
  • Pivotal Tracker
  • Sigma Computing
  • Teamwork Project Management
  • Teamwork Spaces
  • Vercel
  • Webflow
  • Zeplin
  • Zoho BugTracker
  • Zoho Projects
organization
object

organization associated with the workspace

Supported in
  • Asana
  • Cisco Meraki
  • GitLab
  • Hashicorp Terraform Cloud
  • MongoDB Atlas Admin
  • Mural
  • Podio
  • Zeplin
id
string

The unique identifier for an organization

name
string

The name of the organization

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.