Search FloorPlanDeskVariants

GET

api

sys

floorplandeskvariants

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

import requests

url = "https://spaces.nexudus.com/api/sys/floorplandeskvariants"

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/sys/floorplandeskvariants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

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

string

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

number

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

integer

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

string

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

integer

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

string

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

string

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

integer

Filter by iD of the coworker linked to this record.

string

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

string

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

string

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

string

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

string

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

string

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

number

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

number

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

number

Filter by unit price amount.

number

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

string

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

boolean

Filter by whether available monday is enabled.

boolean

Filter by whether available tuesday is enabled.

boolean

Filter by whether available wednesday is enabled.

boolean

Filter by whether available thursday is enabled.

boolean

Filter by whether available friday is enabled.

boolean

Filter by whether available saturday is enabled.

boolean

Filter by whether available sunday is enabled.

string

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

string

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

string

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

string

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

string

Filter by date/time value for available from time.

string

Filter by date/time value for available to time.

string

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

string

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

Range Filters

number

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

number

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

integer

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

integer

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

integer

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

integer

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

number

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

number

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

number

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

number

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

number

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

number

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

number

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

number

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplandeskvariants?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/floorplandeskvariants',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplandeskvariants?' + new URLSearchParams({
    FloorPlanDeskVariant_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/floorplandeskvariants',
    params={
        'FloorPlanDeskVariant_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplandeskvariants?' + new URLSearchParams({
    from_FloorPlanDeskVariant_UpdatedOn: '2025-01-01T00:00',
    to_FloorPlanDeskVariant_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/floorplandeskvariants',
    params={
        'from_FloorPlanDeskVariant_UpdatedOn': '2025-01-01T00:00',
        'to_FloorPlanDeskVariant_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

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>'

import requests

url = "https://spaces.nexudus.com/api/sys/floorplandeskvariants"

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/sys/floorplandeskvariants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

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

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200