Skip to main content
GET
/
api
/
sys
/
floorplandeskvariants
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

​
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-List role.

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 1 for ascending, -1 for descending.

​
Filters

​
FloorPlanDeskVariant_FloorPlanDesk
integer
Filter by Floor Plan Desk Id.
​
FloorPlanDeskVariant_FloorPlanDesk_Name
string
Filter by Floor Plan Desk Name.
​
FloorPlanDeskVariant_FloorPlanDesk_Price
number
Filter by Floor Plan Desk Price.
​
FloorPlanDeskVariant_FloorPlanDesk_FloorPlan_Id
integer
Filter by Floor Plan Desk Floor Plan Id.
​
FloorPlanDeskVariant_FloorPlanDesk_FloorPlan_Name
string
Filter by Floor Plan Desk Floor Plan Name.
​
FloorPlanDeskVariant_FloorPlanDesk_FloorPlan_Business_Id
integer
Filter by Floor Plan Desk Floor Plan Business Id.
​
FloorPlanDeskVariant_FloorPlanDesk_FloorPlan_Business_Name
string
Filter by Floor Plan Desk Floor Plan Business Name.
​
FloorPlanDeskVariant_FloorPlanDesk_FloorPlan_Business_Currency_Code
string
Filter by Floor Plan Desk Floor Plan Business Currency Code.
​
FloorPlanDeskVariant_Coworker
integer
Filter by Coworker Id.
​
FloorPlanDeskVariant_Coworker_FullName
string
Filter by Coworker Full Name.
​
FloorPlanDeskVariant_Coworker_CompanyName
string
Filter by Coworker Company Name.
​
FloorPlanDeskVariant_Coworker_CoworkerType
string
Filter by Coworker Coworker Type.
​
FloorPlanDeskVariant_Coworker_Email
string
Filter by Coworker Email.
​
FloorPlanDeskVariant_Coworker_TeamNames
string
Filter by Coworker Team Names.
​
FloorPlanDeskVariant_Name
string
Filter by Name.
​
FloorPlanDeskVariant_Size
number
Filter by Size.
​
FloorPlanDeskVariant_Capacity
number
Filter by Capacity.
​
FloorPlanDeskVariant_Price
number
Filter by Price.
​
FloorPlanDeskVariant_OccupancyPercentage
number
Filter by Occupancy Percentage.
​
FloorPlanDeskVariant_Notes
string
Filter by Notes.
​
FloorPlanDeskVariant_AvailableMonday
boolean
Filter by Available Monday.
​
FloorPlanDeskVariant_AvailableTuesday
boolean
Filter by Available Tuesday.
​
FloorPlanDeskVariant_AvailableWednesday
boolean
Filter by Available Wednesday.
​
FloorPlanDeskVariant_AvailableThursday
boolean
Filter by Available Thursday.
​
FloorPlanDeskVariant_AvailableFriday
boolean
Filter by Available Friday.
​
FloorPlanDeskVariant_AvailableSaturday
boolean
Filter by Available Saturday.
​
FloorPlanDeskVariant_AvailableSunday
boolean
Filter by Available Sunday.
​
FloorPlanDeskVariant_AccessControlGroupId
string
Filter by Access Control Group Id.
​
FloorPlanDeskVariant_CoworkerContractIds
string
Filter by Coworker Contract Ids.
​
FloorPlanDeskVariant_CoworkerContractFullNames
string
Filter by Coworker Contract Full Names.
​
FloorPlanDeskVariant_CoworkerContractStartDates
string
Filter by Coworker Contract Start Dates.
​
FloorPlanDeskVariant_AvailableFromTime
string
Filter by Available From Time.
​
FloorPlanDeskVariant_AvailableToTime
string
Filter by Available To Time.
​
FloorPlanDeskVariant_AvailableFromTimeLocal
string
Filter by Available From Time Local.
​
FloorPlanDeskVariant_AvailableToTimeLocal
string
Filter by Available To Time Local.

​
Range Filters

​
from_FloorPlanDeskVariant_FloorPlanDeskPrice
number
Filter by floor plan desk price greater than or equal to this value.
​
to_FloorPlanDeskVariant_FloorPlanDeskPrice
number
Filter by floor plan desk price less than or equal to this value.
​
from_FloorPlanDeskVariant_FloorPlanDeskFloorPlanId
integer
Filter by floor plan desk floor plan id greater than or equal to this value.
​
to_FloorPlanDeskVariant_FloorPlanDeskFloorPlanId
integer
Filter by floor plan desk floor plan id less than or equal to this value.
​
from_FloorPlanDeskVariant_FloorPlanDeskFloorPlanBusinessId
integer
Filter by floor plan desk floor plan business id greater than or equal to this value.
​
to_FloorPlanDeskVariant_FloorPlanDeskFloorPlanBusinessId
integer
Filter by floor plan desk floor plan business id less than or equal to this value.
​
from_FloorPlanDeskVariant_Size
number
Filter by size greater than or equal to this value.
​
to_FloorPlanDeskVariant_Size
number
Filter by size less than or equal to this value.
​
from_FloorPlanDeskVariant_Capacity
number
Filter by capacity greater than or equal to this value.
​
to_FloorPlanDeskVariant_Capacity
number
Filter by capacity less than or equal to this value.
​
from_FloorPlanDeskVariant_Price
number
Filter by price greater than or equal to this value.
​
to_FloorPlanDeskVariant_Price
number
Filter by price less than or equal to this value.
​
from_FloorPlanDeskVariant_OccupancyPercentage
number
Filter by occupancy percentage greater than or equal to this value.
​
to_FloorPlanDeskVariant_OccupancyPercentage
number
Filter by occupancy percentage less than or equal to this value.
​
from_FloorPlanDeskVariant_AvailableFromTime
string
Filter by available from time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_FloorPlanDeskVariant_AvailableFromTime
string
Filter by available from time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_FloorPlanDeskVariant_AvailableToTime
string
Filter by available to time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_FloorPlanDeskVariant_AvailableToTime
string
Filter by available to time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_FloorPlanDeskVariant_AvailableFromTimeLocal
string
Filter by available from time local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_FloorPlanDeskVariant_AvailableFromTimeLocal
string
Filter by available from time local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_FloorPlanDeskVariant_AvailableToTimeLocal
string
Filter by available to time local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_FloorPlanDeskVariant_AvailableToTimeLocal
string
Filter by available to time local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_FloorPlanDeskVariant_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_FloorPlanDeskVariant_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_FloorPlanDeskVariant_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_FloorPlanDeskVariant_UpdatedOn
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

​
Code Examples

​
Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/floorplandeskvariants?page=1&size=15&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/sys/floorplandeskvariants?FloorPlanDeskVariant_Name=example-value&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/floorplandeskvariants?from_FloorPlanDeskVariant_UpdatedOn=2025-01-01T00:00&to_FloorPlanDeskVariant_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
FloorPlanDeskVariant[]
The list of FloorPlanDeskVariant records matching the query. See the Get one FloorPlanDeskVariant endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each FloorPlanDeskVariant. The following fields are not included in the Records[] response: FloorPlanDeskId, Notes.To get all fields, fetch the full record using the Get one FloorPlanDeskVariant endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "Records": [
    {
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}