Appearance

Get Workspaces ​

Endpoint ​

http
GET /unified/ticketing/workspaces/{id}
Integrations supported
  • Accelo
  • Basecamp
  • Bitbucket
  • GitLab
  • Help Scout
  • HubSpot
  • Jira Service Management
  • Microsoft 365
  • Microsoft Planner
  • Pivotal Tracker
  • Planhat
  • Teamwork Project Management
  • Trello
  • Wrike
  • Zoho Desk
  • 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
object
Supported in
  • Zoho Projects
id
string

The unique identifier for a organization.

Response Body ​

id
string

The ID of the workspace

Supported in
  • Accelo
  • Basecamp
  • Bitbucket
  • GitLab
  • Help Scout
  • HubSpot
  • Jira Service Management
  • Microsoft 365
  • Microsoft Planner
  • Pivotal Tracker
  • Planhat
  • Teamwork Project Management
  • Trello
  • Wrike
  • Zoho Desk
  • Zoho Projects
name
string

The name of the workspace

Supported in
  • Accelo
  • Basecamp
  • Bitbucket
  • GitLab
  • Help Scout
  • HubSpot
  • Jira Service Management
  • Microsoft 365
  • Microsoft Planner
  • Pivotal Tracker
  • Planhat
  • Teamwork Project Management
  • Trello
  • Wrike
  • Zoho Desk
  • Zoho Projects
status
string

The status of the workspace

All possible enum values:
  • active
  • inactive
Supported in
  • Accelo
  • Microsoft 365
  • Microsoft Planner
  • Teamwork Project Management
  • Trello
  • Wrike
  • Zoho Desk
  • Zoho Projects
description
string

The description of the workspace

Supported in
  • GitLab
  • Teamwork Project Management
  • Trello
  • Wrike
  • Zoho Desk
  • Zoho Projects
created_at
string · date-time

The date and time the workspace was created

Supported in
  • Accelo
  • Basecamp
  • Bitbucket
  • GitLab
  • Help Scout
  • HubSpot
  • Microsoft 365
  • Microsoft Planner
  • Teamwork Project Management
  • Zoho Desk
  • Zoho Projects
updated_at
string · date-time

The date and time the workspace was last updated

Supported in
  • Accelo
  • Basecamp
  • Bitbucket
  • GitLab
  • Help Scout
  • HubSpot
  • Teamwork Project Management
  • Zoho Projects
etag
string

The unique identifier for the specific version of the resource.

Supported in
  • Microsoft 365
  • Microsoft Planner
remote_data
object

Raw data returned from the remote API call.