Get one Workspace

GET

api

collaboration

workspaces

{id}

Get one Workspace

curl --request GET \
  --url https://spaces.nexudus.com/api/collaboration/workspaces/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/collaboration/workspaces/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/collaboration/workspaces/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "AdministratorId": 123,
  "Name": "<string>",
  "VisibleInMySpaces": true,
  "VisibleByEveryone": true,
  "Archived": true,
  "Description": "<string>",
  "Members": [
    123
  ],
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A Workspace represents a collaborative workspace or project area where team members can share files, communicate, and coordinate work within the platform.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the Workspace-Read role.

Path Parameters

integer

required

The Id of the Workspace record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/collaboration/workspaces/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/collaboration/workspaces/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/collaboration/workspaces/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business linked to this record.

integer

ID of the administrator linked to this record.

string

The name value for this workspace.

boolean

Whether visible in my spaces is enabled.

boolean

Whether visible by everyone is enabled.

boolean

Whether this workspace is archived and hidden from active lists.

string

Free-text description of this workspace.

integer[]

List of members linked to this record.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "AdministratorId": 0,
  "Name": "",
  "VisibleInMySpaces": false,
  "VisibleByEveryone": false,
  "Archived": false,
  "Description": null,
  "Members": [],
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "Workspace Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple WorkspacesRetrieve multiple Workspace records by their Ids in a single request.

Get one Workspace

curl --request GET \
  --url https://spaces.nexudus.com/api/collaboration/workspaces/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/collaboration/workspaces/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/collaboration/workspaces/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "AdministratorId": 123,
  "Name": "<string>",
  "VisibleInMySpaces": true,
  "VisibleByEveryone": true,
  "Archived": true,
  "Description": "<string>",
  "Members": [
    123
  ],
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200