Appearance

Get Workspaces ​

Endpoint ​

http
GET /unified/forms/workspaces/{id}
Integrations supported
  • Typeform

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 will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

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

Response Body ​

id
string

The unique identifier of the workspace.

Supported in
  • Typeform
name
string

The name of the workspace.

Supported in
  • Typeform
type
string

The type of the workspace.

organization
object

The organization to which the workspace belongs.

id
string

The unique identifier of the organization.

name
string

The name of the organization.

created_at
string · date-time

The date and time when the workspace was created.

updated_at
string · date-time

The date and time when the workspace was last updated.

remote_data
object

Raw data returned from the remote API call.