Appearance

Get Workspaces ​

Endpoint ​

http
GET /unified/user-directory/workspaces/{id}
Integrations supported
  • Adyen
  • Aha
  • Anthropic
  • Avalara AvaTax
  • Bitbucket
  • Cisco Meraki
  • Contentful Content Management
  • dbt Labs
  • Discord
  • Freshservice
  • Google CloudSQL
  • GitLab
  • Google Ads
  • Google Cloud
  • Hashicorp Terraform Cloud
  • Illow
  • MongoDB Atlas Admin
  • Pivotal Tracker
  • Podio
  • Power BI
  • Render
  • Sigma Computing
  • Teamwork Project Management
  • Teamwork Spaces
  • Vercel
  • Webflow
  • WordPress
  • Workiva
  • Zesty.io
  • Zoho BugTracker
  • Zoho Projects

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
Example: unified
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
Required in
  • Zoho BugTracker
Supported in
  • Zoho Projects

Response Body ​

id
string
REQUIRED · 

Unique identifier for the workspace.

Supported in
  • Adyen
  • Aha
  • Anthropic
  • Avalara AvaTax
  • Bitbucket
  • Cisco Meraki
  • Contentful Content Management
  • dbt Labs
  • Discord
  • Freshservice
  • Google CloudSQL
  • GitLab
  • Google Ads
  • Google Cloud
  • Hashicorp Terraform Cloud
  • Illow
  • MongoDB Atlas Admin
  • Pivotal Tracker
  • Podio
  • Power BI
  • Render
  • Sigma Computing
  • Teamwork Project Management
  • Teamwork Spaces
  • Vercel
  • Webflow
  • WordPress
  • Workiva
  • Zesty.io
  • Zoho BugTracker
  • Zoho Projects
name
string

Name of the workspace.

Supported in
  • Adyen
  • Aha
  • Anthropic
  • Avalara AvaTax
  • Bitbucket
  • Cisco Meraki
  • Contentful Content Management
  • dbt Labs
  • Discord
  • Freshservice
  • Google CloudSQL
  • GitLab
  • Google Ads
  • Google Cloud
  • Hashicorp Terraform Cloud
  • Illow
  • MongoDB Atlas Admin
  • Pivotal Tracker
  • Podio
  • Power BI
  • Render
  • Sigma Computing
  • Teamwork Project Management
  • Teamwork Spaces
  • Vercel
  • Webflow
  • WordPress
  • Workiva
  • Zesty.io
  • Zoho BugTracker
  • Zoho Projects
description
string

Description for the workspace.

Supported in
  • Aha
  • Cisco Meraki
  • Discord
  • Freshservice
  • GitLab
  • Hashicorp Terraform Cloud
  • Podio
  • 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
  • Adyen
  • Anthropic
  • Avalara AvaTax
  • dbt Labs
  • Freshservice
  • Google CloudSQL
  • GitLab
  • Google Ads
  • Google Cloud
  • Hashicorp Terraform Cloud
  • Teamwork Project Management
  • Teamwork Spaces
  • Zoho BugTracker
  • Zoho Projects
created_at
string · date-time

Date and time when the workspace was created.

Supported in
  • Aha
  • Anthropic
  • Avalara AvaTax
  • Bitbucket
  • Contentful Content Management
  • dbt Labs
  • Freshservice
  • Google CloudSQL
  • GitLab
  • Google Cloud
  • Hashicorp Terraform Cloud
  • MongoDB Atlas Admin
  • Pivotal Tracker
  • Podio
  • Sigma Computing
  • Teamwork Project Management
  • Teamwork Spaces
  • Vercel
  • Webflow
  • Workiva
  • Zesty.io
  • Zoho BugTracker
  • Zoho Projects
updated_at
string · date-time

Date and time when the workspace was last updated.

Supported in
  • Aha
  • Avalara AvaTax
  • Bitbucket
  • Contentful Content Management
  • dbt Labs
  • Freshservice
  • Google CloudSQL
  • GitLab
  • Google Cloud
  • Hashicorp Terraform Cloud
  • Pivotal Tracker
  • Sigma Computing
  • Teamwork Project Management
  • Teamwork Spaces
  • Vercel
  • Webflow
  • Workiva
  • Zesty.io
  • Zoho BugTracker
  • Zoho Projects
organization
object

organization associated with the workspace

Supported in
  • Anthropic
  • Avalara AvaTax
  • Cisco Meraki
  • GitLab
  • Hashicorp Terraform Cloud
  • MongoDB Atlas Admin
  • Podio
  • Workiva
  • Zesty.io
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.