Skip to main content
GET
/
api
/
spaces
/
coworkersettings
/
{id}
Get one CoworkerSetting
curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/coworkersettings/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "CoworkerId": 123,
  "Name": "<string>",
  "Value": "<string>",
  "EncryptedValue": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A CoworkerSetting is an internal name/value pair used to store arbitrary customer-related settings. Settings are scoped to a single customer (CoworkerId) and identified by a unique Name key. The value can be stored as plain text (Value) or in encrypted form (EncryptedValue) for sensitive data. CoworkerSettings can also be accessed and managed via the Members Portal and the App Public API in the context of the logged-in customer.

​
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 CoworkerSetting-Read role.

​
Path Parameters

​
id
integer
required
The Id of the CoworkerSetting record to retrieve.

​
Code Examples

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

​
Response

​
200

​
CoworkerId
integer
The customer this setting belongs to.
​
Name
string
The setting key name.
​
Value
string
The plain-text value for this setting.
​
EncryptedValue
string
An encrypted version of the setting value, used for sensitive data.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "CoworkerId": 0,
  "Name": "",
  "Value": null,
  "EncryptedValue": null,
  "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": "CoworkerSetting Example",
  "LocalizationDetails": null,
  "CustomFields": null
}