Search FloorPlanDeskVariants - Nexudus Platform

GET

api

sys

floorplandeskvariants

Search FloorPlanDeskVariants

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/floorplandeskvariants \
  --header 'Authorization: Basic <encoded-value>'

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-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. 0 for ascending, 1 for descending.

Filters

FloorPlanDeskVariant_FloorPlanDesk

integer

Filter by iD of the floor plan desk linked to this record.

FloorPlanDeskVariant_FloorPlanDesk_Name

string

Filter by display name of the linked floor plan desk (read-only).

FloorPlanDeskVariant_FloorPlanDesk_Price

number

Filter by the floor plan desk price value for this floor plan desk variant.

FloorPlanDeskVariant_FloorPlanDesk_FloorPlan_Id

integer

Filter by iD of the floor plan desk floor plan associated with this record.

FloorPlanDeskVariant_FloorPlanDesk_FloorPlan_Name

string

Filter by display name of the linked floor plan desk floor plan (read-only).

FloorPlanDeskVariant_FloorPlanDesk_FloorPlan_Business_Id

integer

Filter by iD of the floor plan desk floor plan business associated with this record.

FloorPlanDeskVariant_FloorPlanDesk_FloorPlan_Business_Name

string

Filter by display name of the linked floor plan desk floor plan business (read-only).

FloorPlanDeskVariant_FloorPlanDesk_FloorPlan_Business_Currency_Code

string

Filter by the floor plan desk floor plan business currency code value for this floor plan desk variant.

FloorPlanDeskVariant_Coworker

integer

Filter by iD of the coworker linked to this record.

FloorPlanDeskVariant_Coworker_FullName

string

Filter by display name of the linked coworker full (read-only).

FloorPlanDeskVariant_Coworker_CompanyName

string

Filter by display name of the linked coworker company (read-only).

FloorPlanDeskVariant_Coworker_CoworkerType

string

Filter by the coworker coworker type value for this floor plan desk variant.

FloorPlanDeskVariant_Coworker_Email

string

Filter by the coworker email value for this floor plan desk variant.

FloorPlanDeskVariant_Coworker_TeamNames

string

Filter by the coworker team names value for this floor plan desk variant.

FloorPlanDeskVariant_Name

string

Filter by the name value for this floor plan desk variant.

FloorPlanDeskVariant_Size

number

Filter by the size value for this floor plan desk variant.

FloorPlanDeskVariant_Capacity

number

Filter by the capacity value for this floor plan desk variant.

FloorPlanDeskVariant_Price

number

Filter by unit price amount.

FloorPlanDeskVariant_OccupancyPercentage

number

Filter by the occupancy percentage value for this floor plan desk variant.

FloorPlanDeskVariant_Notes

string

Filter by optional notes or comments about this floor plan desk variant.

FloorPlanDeskVariant_AvailableMonday

boolean

Filter by whether available monday is enabled.

FloorPlanDeskVariant_AvailableTuesday

boolean

Filter by whether available tuesday is enabled.

FloorPlanDeskVariant_AvailableWednesday

boolean

Filter by whether available wednesday is enabled.

FloorPlanDeskVariant_AvailableThursday

boolean

Filter by whether available thursday is enabled.

FloorPlanDeskVariant_AvailableFriday

boolean

Filter by whether available friday is enabled.

FloorPlanDeskVariant_AvailableSaturday

boolean

Filter by whether available saturday is enabled.

FloorPlanDeskVariant_AvailableSunday

boolean

Filter by whether available sunday is enabled.

FloorPlanDeskVariant_AccessControlGroupId

string

Filter by iD of the access control group associated with this record.

FloorPlanDeskVariant_CoworkerContractIds

string

Filter by the coworker contract ids value for this floor plan desk variant.

FloorPlanDeskVariant_CoworkerContractFullNames

string

Filter by the coworker contract full names value for this floor plan desk variant.

FloorPlanDeskVariant_CoworkerContractStartDates

string

Filter by the coworker contract start dates value for this floor plan desk variant.

FloorPlanDeskVariant_AvailableFromTime

string

Filter by date/time value for available from time.

FloorPlanDeskVariant_AvailableToTime

string

Filter by date/time value for available to time.

FloorPlanDeskVariant_AvailableFromTimeLocal

string

Filter by date/time value for available from time local.

FloorPlanDeskVariant_AvailableToTimeLocal

string

Filter by date/time value for available to time local.

Range Filters

from_FloorPlanDeskVariant_FloorPlanDeskPrice

number

Filter by the floor plan desk price value for this floor plan desk variant greater than or equal to this value.

to_FloorPlanDeskVariant_FloorPlanDeskPrice

number

Filter by the floor plan desk price value for this floor plan desk variant less than or equal to this value.

from_FloorPlanDeskVariant_FloorPlanDeskFloorPlanId

integer

Filter by iD of the floor plan desk floor plan associated with this record greater than or equal to this value.

to_FloorPlanDeskVariant_FloorPlanDeskFloorPlanId

integer

Filter by iD of the floor plan desk floor plan associated with this record less than or equal to this value.

from_FloorPlanDeskVariant_FloorPlanDeskFloorPlanBusinessId

integer

Filter by iD of the floor plan desk floor plan business associated with this record greater than or equal to this value.

to_FloorPlanDeskVariant_FloorPlanDeskFloorPlanBusinessId

integer

Filter by iD of the floor plan desk floor plan business associated with this record less than or equal to this value.

from_FloorPlanDeskVariant_Size

number

Filter by the size value for this floor plan desk variant greater than or equal to this value.

to_FloorPlanDeskVariant_Size

number

Filter by the size value for this floor plan desk variant less than or equal to this value.

from_FloorPlanDeskVariant_Capacity

number

Filter by the capacity value for this floor plan desk variant greater than or equal to this value.

to_FloorPlanDeskVariant_Capacity

number

Filter by the capacity value for this floor plan desk variant less than or equal to this value.

from_FloorPlanDeskVariant_Price

number

Filter by unit price amount greater than or equal to this value.

to_FloorPlanDeskVariant_Price

number

Filter by unit price amount less than or equal to this value.

from_FloorPlanDeskVariant_OccupancyPercentage

number

Filter by the occupancy percentage value for this floor plan desk variant greater than or equal to this value.

to_FloorPlanDeskVariant_OccupancyPercentage

number

Filter by the occupancy percentage value for this floor plan desk variant less than or equal to this value.

from_FloorPlanDeskVariant_AvailableFromTime

string

Filter by date/time value for available from time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_FloorPlanDeskVariant_AvailableFromTime

string

Filter by date/time value for available from time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_FloorPlanDeskVariant_AvailableToTime

string

Filter by date/time value for available to time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_FloorPlanDeskVariant_AvailableToTime

string

Filter by date/time value for available to time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_FloorPlanDeskVariant_AvailableFromTimeLocal

string

Filter by date/time value for available from time local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_FloorPlanDeskVariant_AvailableFromTimeLocal

string

Filter by date/time value for available from time local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_FloorPlanDeskVariant_AvailableToTimeLocal

string

Filter by date/time value for available to time local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_FloorPlanDeskVariant_AvailableToTimeLocal

string

Filter by date/time value for 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=0" \
  -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=0" \
  -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=0" \
  -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 populated 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 (0 = 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": [
    {
      "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,
      "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
}

Get one FloorPlanDeskVariantRetrieve a single FloorPlanDeskVariant record by its Id.

Search FloorPlanDeskVariants

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/floorplandeskvariants \
  --header 'Authorization: Basic <encoded-value>'

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200