GET

api

public

coworkers

profiles

current

benefits

Get Customer Benefits

curl --request GET \
  --url https://spaces.nexudus.com/api/public/coworkers/profiles/current/benefits \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/public/coworkers/profiles/current/benefits"

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/public/coworkers/profiles/current/benefits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Personal": {},
  "Personal.BookingCredits": [
    {}
  ],
  "Personal.BookingCredits[].Id": 123,
  "Personal.BookingCredits[].Name": "<string>",
  "Personal.BookingCredits[].TotalCredit": 123,
  "Personal.BookingCredits[].RemainingCredit": 123,
  "Personal.BookingCredits[].CaneBeUsedForBookings": true,
  "Personal.BookingCredits[].CaneBeUsedForEvents": true,
  "Personal.BookingCredits[].IsUniversalCredit": true,
  "Personal.BookingCredits[].IsFromTariff": true,
  "Personal.BookingCredits[].ExpireDate": {},
  "Personal.ExtraServices": [
    {}
  ],
  "Personal.ExtraServices[].Id": 123,
  "Personal.ExtraServices[].ExtraService.Id": 123,
  "Personal.ExtraServices[].ExtraService.Name": "<string>",
  "Personal.ExtraServices[].ExtraService.IsPrintingCredit": true,
  "Personal.ExtraServices[].TotalUses": 123,
  "Personal.ExtraServices[].RemainingUses": 123,
  "Personal.ExtraServices[].ChargePeriod": "<string>",
  "Personal.ExtraServices[].IsFromTariff": true,
  "Personal.ExtraServices[].ExpireDate": {},
  "Personal.TimePasses": [
    {}
  ],
  "Personal.TimePasses[].Id": 123,
  "Personal.TimePasses[].TimePass.Id": 123,
  "Personal.TimePasses[].TimePass.Name": "<string>",
  "Personal.TimePasses[].TotalUses": {},
  "Personal.TimePasses[].RemainingUses": {},
  "Personal.TimePasses[].Used": true,
  "Personal.TimePasses[].IsFromTariff": true,
  "Personal.TimePasses[].ExpireDate": {},
  "Team": {},
  "401 Unauthorized": {}
}

Get Customer Benefits

Returns all plan benefits currently available to the active customer profile. Benefits are granted through active plan (tariff) subscriptions and include booking credits, extra services (such as printing), and time passes. The portal uses this to display the benefits panel on the My Plans page and to gate access to credit-based features.

Authentication

Requires a valid customer bearer token.

Query Parameters

string

Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation.

Response

The response is split into Personal benefits (belonging to the individual profile) and Team benefits (shared across the customer’s team).

object

Benefits belonging to the individual customer profile.

array

Booking credit allowances granted by active plans.

number

Unique identifier for the booking credit record.

string

Display name of the booking credit allowance.

number

Total credit amount granted (in the location’s currency).

number

Remaining credit balance available to spend.

boolean

true when this credit can be applied to room and desk bookings.

boolean

true when this credit can be applied to event ticket purchases.

boolean

true when this credit applies to all resource types.

boolean

true when this credit was granted by an active plan subscription rather than manually assigned.

string | null

ISO 8601 datetime when this credit expires. null if it does not expire.

array

Extra service allowances (e.g. printing credits) granted by active plans.

number

Unique identifier for the extra service record.

number

Identifier of the extra service type.

string

Display name of the extra service.

boolean

true when this service is a printing credit (e.g. PaperCut integration).

number

Total number of uses granted.

number

Remaining uses available.

string

How uses are measured: "Minutes", "Days", "Weeks", "Months", "Uses", or "FourWeekMonths".

boolean

true when granted by an active plan subscription.

string | null

ISO 8601 expiry datetime. null if it does not expire.

array

Time pass allowances granted by active plans.

number

Unique identifier for the time pass record.

number

Identifier of the time pass type.

string

Display name of the time pass.

number | null

Total number of uses granted. null for unlimited passes.

number | null

Remaining uses. null for unlimited passes.

boolean

true when this specific time pass instance has been used.

boolean

true when granted by an active plan subscription.

string | null

ISO 8601 expiry datetime. null if it does not expire.

object

Benefits shared with the customer’s team. Contains the same structure as Personal (BookingCredits, ExtraServices, TimePasses).

Example Response

{
  "Personal": {
    "BookingCredits": [
      {
        "Id": 5,
        "Name": "Monthly Booking Allowance",
        "TotalCredit": 200.0,
        "RemainingCredit": 145.5,
        "CaneBeUsedForBookings": true,
        "CaneBeUsedForEvents": false,
        "IsUniversalCredit": false,
        "IsFromTariff": true,
        "ExpireDate": "2026-04-30T23:59:59Z"
      }
    ],
    "ExtraServices": [],
    "TimePasses": [
      {
        "Id": 12,
        "TimePass": { "Id": 3, "Name": "Day Pass" },
        "TotalUses": 5,
        "RemainingUses": 3,
        "Used": false,
        "IsFromTariff": true,
        "ExpireDate": null
      }
    ]
  },
  "Team": {
    "BookingCredits": [],
    "ExtraServices": [],
    "TimePasses": []
  }
}

TypeScript Integration

import endpoints from '@/api/endpoints'
import { MyBenefits } from '@/types/public/billing/MyBenefits'
import { useData } from '@/api/fetchData'
import { createShape } from '@/helpers/shape-helper'

const shape = createShape<MyBenefits>()([
  'Personal.BookingCredits.Id',
  'Personal.BookingCredits.Name',
  'Personal.BookingCredits.RemainingCredit',
  'Personal.TimePasses.Id',
  'Personal.TimePasses.TimePass.Name',
  'Personal.TimePasses.RemainingUses',
])

const { resource: benefits } = useData<MyBenefits>(httpClient, endpoints.coworkers.benefits, {
  shape: shape.fields,
})

Usage in Portal

Context	Source file
My Plans page — benefits panel	`src/views/user/plans/useMyBenefitsData.ts`
Benefits display component	`src/views/user/plans/components/MyBenefitsSection.tsx`

Error Responses

error

The bearer token is missing, expired, or invalid.

Method	Endpoint	Description
`GET`	`/api/public/coworkers/profiles`	List all profiles for the current session
`GET`	`/api/public/plans/my`	List active plans for the current customer
`PUT`	`/api/public/coworkers/profiles/current`	Switch the active profile

Impersonate CustomerGenerate an impersonation token so a team administrator can sign in as another team member.

Get Customer Benefits

curl --request GET \
  --url https://spaces.nexudus.com/api/public/coworkers/profiles/current/benefits \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/public/coworkers/profiles/current/benefits"

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/public/coworkers/profiles/current/benefits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Personal": {},
  "Personal.BookingCredits": [
    {}
  ],
  "Personal.BookingCredits[].Id": 123,
  "Personal.BookingCredits[].Name": "<string>",
  "Personal.BookingCredits[].TotalCredit": 123,
  "Personal.BookingCredits[].RemainingCredit": 123,
  "Personal.BookingCredits[].CaneBeUsedForBookings": true,
  "Personal.BookingCredits[].CaneBeUsedForEvents": true,
  "Personal.BookingCredits[].IsUniversalCredit": true,
  "Personal.BookingCredits[].IsFromTariff": true,
  "Personal.BookingCredits[].ExpireDate": {},
  "Personal.ExtraServices": [
    {}
  ],
  "Personal.ExtraServices[].Id": 123,
  "Personal.ExtraServices[].ExtraService.Id": 123,
  "Personal.ExtraServices[].ExtraService.Name": "<string>",
  "Personal.ExtraServices[].ExtraService.IsPrintingCredit": true,
  "Personal.ExtraServices[].TotalUses": 123,
  "Personal.ExtraServices[].RemainingUses": 123,
  "Personal.ExtraServices[].ChargePeriod": "<string>",
  "Personal.ExtraServices[].IsFromTariff": true,
  "Personal.ExtraServices[].ExpireDate": {},
  "Personal.TimePasses": [
    {}
  ],
  "Personal.TimePasses[].Id": 123,
  "Personal.TimePasses[].TimePass.Id": 123,
  "Personal.TimePasses[].TimePass.Name": "<string>",
  "Personal.TimePasses[].TotalUses": {},
  "Personal.TimePasses[].RemainingUses": {},
  "Personal.TimePasses[].Used": true,
  "Personal.TimePasses[].IsFromTariff": true,
  "Personal.TimePasses[].ExpireDate": {},
  "Team": {},
  "401 Unauthorized": {}
}

​Get Customer Benefits

​Authentication

​Query Parameters

​Response

​Example Response

​TypeScript Integration

​Usage in Portal

​Error Responses

​Related Endpoints

Get Customer Benefits

Authentication

Query Parameters

Response

Example Response

TypeScript Integration

Usage in Portal

Error Responses

Related Endpoints