Skip to main content
GET
/
api
/
sys
/
floorplandeskvariants
/
{id}
Get one FloorPlanDeskVariant
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/floorplandeskvariants/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "FloorPlanDeskId": 123,
  "FloorPlanDeskName": "<string>",
  "FloorPlanDeskPrice": 123,
  "FloorPlanDeskFloorPlanId": 123,
  "FloorPlanDeskFloorPlanName": "<string>",
  "FloorPlanDeskFloorPlanBusinessId": 123,
  "FloorPlanDeskFloorPlanBusinessName": "<string>",
  "FloorPlanDeskFloorPlanBusinessCurrencyCode": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerCoworkerType": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerTeamNames": "<string>",
  "Name": "<string>",
  "Size": 123,
  "Capacity": 123,
  "Price": 123,
  "OccupancyPercentage": 123,
  "Notes": "<string>",
  "AvailableMonday": true,
  "AvailableTuesday": true,
  "AvailableWednesday": true,
  "AvailableThursday": true,
  "AvailableFriday": true,
  "AvailableSaturday": true,
  "AvailableSunday": true,
  "AccessControlGroupId": "<string>",
  "CoworkerContractIds": "<string>",
  "CoworkerContractFullNames": "<string>",
  "CoworkerContractStartDates": "<string>",
  "AvailableFromTime": "<string>",
  "AvailableToTime": "<string>",
  "AvailableFromTimeLocal": "<string>",
  "AvailableToTimeLocal": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A FloorPlanDeskVariant defines an alternative visual representation or configuration for a desk on a floor plan. Variants allow the same desk to be displayed differently based on context or state.

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

​
Path Parameters

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

​
Code Examples

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

​
Response

​
200

​
FloorPlanDeskId
integer
ID of the floor plan desk linked to this record.
​
FloorPlanDeskName
string
Display name of the linked floor plan desk (read-only).
​
FloorPlanDeskPrice
number
The floor plan desk price value for this floor plan desk variant.
​
FloorPlanDeskFloorPlanId
integer
ID of the floor plan desk floor plan associated with this record.
​
FloorPlanDeskFloorPlanName
string
Display name of the linked floor plan desk floor plan (read-only).
​
FloorPlanDeskFloorPlanBusinessId
integer
ID of the floor plan desk floor plan business associated with this record.
​
FloorPlanDeskFloorPlanBusinessName
string
Display name of the linked floor plan desk floor plan business (read-only).
​
FloorPlanDeskFloorPlanBusinessCurrencyCode
string
The floor plan desk floor plan business currency code value for this floor plan desk variant.
​
CoworkerId
integer
ID of the coworker linked to this record.
​
CoworkerFullName
string
Display name of the linked coworker full (read-only).
​
CoworkerCompanyName
string
Display name of the linked coworker company (read-only).
​
CoworkerCoworkerType
string
The coworker coworker type value for this floor plan desk variant.
​
CoworkerEmail
string
The coworker email value for this floor plan desk variant.
​
CoworkerTeamNames
string
The coworker team names value for this floor plan desk variant.
​
Name
string
The name value for this floor plan desk variant.
​
Size
number
The size value for this floor plan desk variant.
​
Capacity
number
The capacity value for this floor plan desk variant.
​
Price
number
Unit price amount.
​
OccupancyPercentage
number
The occupancy percentage value for this floor plan desk variant.
​
Notes
string
Optional notes or comments about this floor plan desk variant.
​
AvailableMonday
boolean
Whether available monday is enabled.
​
AvailableTuesday
boolean
Whether available tuesday is enabled.
​
AvailableWednesday
boolean
Whether available wednesday is enabled.
​
AvailableThursday
boolean
Whether available thursday is enabled.
​
AvailableFriday
boolean
Whether available friday is enabled.
​
AvailableSaturday
boolean
Whether available saturday is enabled.
​
AvailableSunday
boolean
Whether available sunday is enabled.
​
AccessControlGroupId
string
ID of the access control group associated with this record.
​
CoworkerContractIds
string
The coworker contract ids value for this floor plan desk variant.
​
CoworkerContractFullNames
string
The coworker contract full names value for this floor plan desk variant.
​
CoworkerContractStartDates
string
The coworker contract start dates value for this floor plan desk variant.
​
AvailableFromTime
string
Date/time value for available from time.
​
AvailableToTime
string
Date/time value for available to time.
​
AvailableFromTimeLocal
string
Date/time value for available from time local.
​
AvailableToTimeLocal
string
Date/time value for available to time local.
​
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
{
  "FloorPlanDeskId": 0,
  "FloorPlanDeskName": null,
  "FloorPlanDeskPrice": null,
  "FloorPlanDeskFloorPlanId": null,
  "FloorPlanDeskFloorPlanName": null,
  "FloorPlanDeskFloorPlanBusinessId": null,
  "FloorPlanDeskFloorPlanBusinessName": null,
  "FloorPlanDeskFloorPlanBusinessCurrencyCode": null,
  "CoworkerId": null,
  "CoworkerFullName": null,
  "CoworkerCompanyName": null,
  "CoworkerCoworkerType": null,
  "CoworkerEmail": null,
  "CoworkerTeamNames": null,
  "Name": "",
  "Size": null,
  "Capacity": null,
  "Price": null,
  "OccupancyPercentage": 0,
  "Notes": null,
  "AvailableMonday": false,
  "AvailableTuesday": false,
  "AvailableWednesday": false,
  "AvailableThursday": false,
  "AvailableFriday": false,
  "AvailableSaturday": false,
  "AvailableSunday": false,
  "AccessControlGroupId": null,
  "CoworkerContractIds": null,
  "CoworkerContractFullNames": null,
  "CoworkerContractStartDates": null,
  "AvailableFromTime": null,
  "AvailableToTime": null,
  "AvailableFromTimeLocal": null,
  "AvailableToTimeLocal": 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": "FloorPlanDeskVariant Example",
  "LocalizationDetails": null,
  "CustomFields": null
}