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, called a Package by operators, defines how a location’s floor plan unit can be contracted under different availability, setup, or pricing conditions. Packages can split an office between customers on different weekdays, or offer the same unit as a private office (full-time or fractional), storage unit, or event space.

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 required floor plan unit this variant configures; the unit determines the owning location.

string

Filter by display value for FloorPlanDesk.Name..

number

Filter by display value for FloorPlanDesk.Price..

integer

Filter by display value for FloorPlanDesk.FloorPlan.Id..

string

Filter by display value for FloorPlanDesk.FloorPlan.Name..

integer

Filter by display value for FloorPlanDesk.FloorPlan.Business.Id..

string

Filter by display value for FloorPlanDesk.FloorPlan.Business.Name..

string

Filter by display value for FloorPlanDesk.FloorPlan.Business.Currency.Code..

integer

Filter by iD of the optional customer this variant is associated with.

string

Filter by display value for Coworker.FullName..

string

Filter by display value for Coworker.CompanyName..

string

Filter by display value for Coworker.CoworkerType..

string

Filter by display value for Coworker.Email..

string

Filter by display value for Coworker.TeamNames..

string

Filter by required, non-empty display name for this alternate floor plan unit configuration.

number

Filter by optional floor area in square metres for this configuration.

number

Filter by optional number of seats this configuration can accommodate.

number

Filter by optional target price in the owning location’s currency, used for occupancy reporting rather than billing.

number

Filter by percentage of the floor plan unit’s total possible use reported when this package is contracted; normally divide use evenly across packages according to the number of weekdays each is available.

string

Filter by optional internal notes about this configuration, limited to 255 characters.

boolean

Filter by whether this configuration is marked available on Monday; scheduling conflict checks treat matching enabled weekday flags as overlapping.

boolean

Filter by whether this configuration is marked available on Tuesday; scheduling conflict checks treat matching enabled weekday flags as overlapping.

boolean

Filter by whether this configuration is marked available on Wednesday; scheduling conflict checks treat matching enabled weekday flags as overlapping.

boolean

Filter by whether this configuration is marked available on Thursday; scheduling conflict checks treat matching enabled weekday flags as overlapping.

boolean

Filter by whether this configuration is marked available on Friday; scheduling conflict checks treat matching enabled weekday flags as overlapping.

boolean

Filter by whether this configuration is marked available on Saturday; scheduling conflict checks treat matching enabled weekday flags as overlapping.

boolean

Filter by whether this configuration is marked available on Sunday; scheduling conflict checks treat matching enabled weekday flags as overlapping.

string

Filter by obsolete single-provider access-control group identifier retained for legacy records; do not set it through floor plan administration.

string

Filter by read-only denormalized IDs of contracts linked to this configuration; update the contracts rather than this projection.

string

Filter by read-only denormalized customer names from contracts linked to this configuration; update the contracts rather than this projection.

string

Filter by read-only denormalized start dates from contracts linked to this configuration; update the contracts rather than this projection.

string

Filter by optional inclusive UTC start of this configuration’s availability window; it must precede AvailableToTime when both are set.

string

Filter by optional inclusive UTC end of this configuration’s availability window; null means no end, and it must follow AvailableFromTime when both are set.

string

Filter by derived location-local representation of AvailableFromTime populated by date-localization infrastructure; change AvailableFromTime instead.

string

Filter by derived location-local representation of AvailableToTime populated by date-localization infrastructure; change AvailableToTime instead.

Range Filters

number

Filter by display value for FloorPlanDesk.Price. greater than or equal to this value.

number

Filter by display value for FloorPlanDesk.Price. less than or equal to this value.

integer

Filter by display value for FloorPlanDesk.FloorPlan.Id. greater than or equal to this value.

integer

Filter by display value for FloorPlanDesk.FloorPlan.Id. less than or equal to this value.

integer

Filter by display value for FloorPlanDesk.FloorPlan.Business.Id. greater than or equal to this value.

integer

Filter by display value for FloorPlanDesk.FloorPlan.Business.Id. less than or equal to this value.

number

Filter by optional floor area in square metres for this configuration greater than or equal to this value.

number

Filter by optional floor area in square metres for this configuration less than or equal to this value.

number

Filter by optional number of seats this configuration can accommodate greater than or equal to this value.

number

Filter by optional number of seats this configuration can accommodate less than or equal to this value.

number

Filter by optional target price in the owning location’s currency, used for occupancy reporting rather than billing greater than or equal to this value.

number

Filter by optional target price in the owning location’s currency, used for occupancy reporting rather than billing less than or equal to this value.

number

string

Filter by optional inclusive UTC start of this configuration’s availability window; it must precede AvailableToTime when both are set greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional inclusive UTC start of this configuration’s availability window; it must precede AvailableToTime when both are set less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional inclusive UTC end of this configuration’s availability window; null means no end, and it must follow AvailableFromTime when both are set greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional inclusive UTC end of this configuration’s availability window; null means no end, and it must follow AvailableFromTime when both are set less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by derived location-local representation of AvailableFromTime populated by date-localization infrastructure; change AvailableFromTime instead greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by derived location-local representation of AvailableFromTime populated by date-localization infrastructure; change AvailableFromTime instead less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by derived location-local representation of AvailableToTime populated by date-localization infrastructure; change AvailableToTime instead greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by derived location-local representation of AvailableToTime populated by date-localization infrastructure; change AvailableToTime instead 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: 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": [
    {
      "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,
      "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
}

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