Appearance

Get Workspaces ​

Endpoint ​

http
GET /unified/user-directory/workspaces/{id}
Integrations supported
  • Aha
  • Bitbucket
  • Cisco Meraki
  • Contentful Content Management
  • dbt Labs
  • Discord
  • Freshservice
  • GitLab
  • Google Ads
  • Google Cloud
  • Illow
  • Pivotal Tracker
  • Power BI
  • Sigma Computing
  • Teamwork Project Management
  • Teamwork Spaces
  • Vercel
  • Webflow
  • WordPress
  • 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.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
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
  • Aha
  • Bitbucket
  • Cisco Meraki
  • Contentful Content Management
  • dbt Labs
  • Discord
  • Freshservice
  • GitLab
  • Google Ads
  • Google Cloud
  • Illow
  • Pivotal Tracker
  • Power BI
  • Sigma Computing
  • Teamwork Project Management
  • Teamwork Spaces
  • Vercel
  • Webflow
  • WordPress
  • Zoho BugTracker
  • Zoho Projects
name
string

Name of the workspace.

Supported in
  • Aha
  • Bitbucket
  • Cisco Meraki
  • Contentful Content Management
  • dbt Labs
  • Discord
  • Freshservice
  • GitLab
  • Google Ads
  • Google Cloud
  • Illow
  • Pivotal Tracker
  • Power BI
  • Sigma Computing
  • Teamwork Project Management
  • Teamwork Spaces
  • Vercel
  • Webflow
  • WordPress
  • Zoho BugTracker
  • Zoho Projects
description
string

Description for the workspace.

Supported in
  • Aha
  • Cisco Meraki
  • Discord
  • Freshservice
  • GitLab
  • Teamwork Project Management
  • Teamwork Spaces
  • WordPress
  • Zoho BugTracker
  • Zoho Projects
status
string

Status for the workspace

All possible enum values:
  • active
  • inactive
Supported in
  • dbt Labs
  • Freshservice
  • GitLab
  • Google Ads
  • Google 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
  • Bitbucket
  • Contentful Content Management
  • dbt Labs
  • Freshservice
  • GitLab
  • Google Cloud
  • Pivotal Tracker
  • Sigma Computing
  • Teamwork Project Management
  • Teamwork Spaces
  • Vercel
  • Webflow
  • Zoho BugTracker
  • Zoho Projects
updated_at
string · date-time

Date and time when the workspace was last updated.

Supported in
  • Aha
  • Bitbucket
  • Contentful Content Management
  • dbt Labs
  • Freshservice
  • GitLab
  • Google Cloud
  • Pivotal Tracker
  • Sigma Computing
  • Teamwork Project Management
  • Teamwork Spaces
  • Vercel
  • Webflow
  • Zoho BugTracker
  • Zoho Projects
organization
object

organization associated with the workspace

Supported in
  • Cisco Meraki
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.