GET

api

public

teams

{teamId}

kpi

Get Team KPIs

curl --request GET \
  --url https://spaces.nexudus.com/api/public/teams/{teamId}/kpi \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/public/teams/{teamId}/kpi"

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/teams/{teamId}/kpi', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Kpi": [
    {}
  ],
  "Kpi[].CoworkerId": 123,
  "Kpi[].CoworkerFullName": "<string>",
  "Kpi[].CoworkerEmail": "<string>",
  "Kpi[].UninvoicedProducts": 123,
  "Kpi[].UninvoicedExtraServices": 123,
  "Kpi[].UnivoicedEventAttendees": 123,
  "Kpi[].UnivoicedTimepasses": 123,
  "Kpi[].RemainingBookingCredit": 123,
  "Kpi[].RemainingTimeCreditMinutes": 123,
  "Kpi[].RemainingTimeCreditDays": 123,
  "Kpi[].RemainingTimeCreditWeeks": 123,
  "Kpi[].RemainingTimeCreditMonths": 123,
  "Kpi[].RemainingTimeCreditUses": 123,
  "Kpi[].RemainingTimePassesMinutes": 123,
  "Kpi[].RemainingTimePassesCount": 123,
  "Kpi[].BookedTimeTotal": 123,
  "Kpi[].BookedTimeThisMonth": 123,
  "Kpi[].CheckedTimeTotal": 123,
  "Kpi[].CheckedTimeThisMonth": 123,
  "401 Unauthorized": {},
  "404 Not Found": {}
}

Get Team KPIs

Returns key performance indicators for every member of a team. Each entry includes uninvoiced charges, remaining booking and time credits, and total/monthly usage. Used on the team dashboard to give administrators a quick financial and usage overview.

Authentication

Requires a valid customer bearer token. The customer must be a team administrator of the specified team.

Path Parameters

number

required

Numeric identifier of the team. Returned as Id from GET /api/public/teams/my.

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

TeamKpi[]

required

Array of per-member KPI objects.

Per-Member Fields

number

Numeric identifier of the team member.

string

Display name of the team member.

string

Email address of the team member.

number

Count of purchased products not yet invoiced.

number

Count of extra services not yet invoiced.

number

Count of event attendee charges not yet invoiced. Note the typo (Univoiced) — it is preserved as-is in the API.

number

Count of time passes not yet invoiced. Note the typo (Univoiced) — it is preserved as-is in the API.

number

Remaining booking credit balance.

number

Remaining time credit in minutes.

number

Remaining time credit in days.

number

Remaining time credit in weeks.

number

Remaining time credit in months.

number

Remaining time credit uses.

number

Remaining time pass minutes.

number

Remaining time pass count.

number

Total booked time in minutes across all time.

number

Total booked time in minutes for the current month.

number

Total checked-in time in minutes across all time.

number

Total checked-in time in minutes for the current month.

Examples

Fetch team KPIs

GET /api/public/teams/55/kpi
Authorization: Bearer {token}

{
  "Kpi": [
    {
      "CoworkerId": 101,
      "CoworkerFullName": "Jane Smith",
      "CoworkerEmail": "jane@techinnovators.com",
      "UninvoicedProducts": 2,
      "UninvoicedExtraServices": 0,
      "UnivoicedEventAttendees": 1,
      "UnivoicedTimepasses": 0,
      "RemainingBookingCredit": 500,
      "RemainingTimeCreditMinutes": 120,
      "RemainingTimeCreditDays": 0,
      "RemainingTimeCreditWeeks": 0,
      "RemainingTimeCreditMonths": 0,
      "RemainingTimeCreditUses": 5,
      "RemainingTimePassesMinutes": 60,
      "RemainingTimePassesCount": 1,
      "BookedTimeTotal": 4200,
      "BookedTimeThisMonth": 360,
      "CheckedTimeTotal": 3800,
      "CheckedTimeThisMonth": 300
    }
  ]
}

TypeScript Integration

import { endpoints } from '@/api/endpoints'
import { TeamKpiList } from '@/types/endpoints/TeamKpi'
import { useData } from '@/hooks/useData'

const { resource: kpiData } = useData<TeamKpiList>(httpClient, endpoints.teams.kpi(teamId), { shape: { fields: ['Kpi'] } })

Usage in Portal

Context	Source file
Team dashboard KPI section (`/dashboard/team/{teamId}`)	`src/views/user/dashboards/team/components/TeamKpiSection.tsx`

Error Responses

error

The customer is not authenticated or the session has expired.

error

Team with the specified ID does not exist.

Method	Endpoint	Description
`GET`	`/api/public/teams/{teamId}/metrics`	Team performance metrics
`GET`	`/api/public/teams/{teamId}/attendance`	Team attendance data
`GET`	`/api/public/teams/{teamId}/profile`	Full team profile
`GET`	`/api/public/teams/my`	List the customer’s teams

Get Team MetricsReturns monthly financial and usage metrics for a team, including invoiced amounts, bookings, and check-in time.

Get Team KPIs

curl --request GET \
  --url https://spaces.nexudus.com/api/public/teams/{teamId}/kpi \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/public/teams/{teamId}/kpi"

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/teams/{teamId}/kpi', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Kpi": [
    {}
  ],
  "Kpi[].CoworkerId": 123,
  "Kpi[].CoworkerFullName": "<string>",
  "Kpi[].CoworkerEmail": "<string>",
  "Kpi[].UninvoicedProducts": 123,
  "Kpi[].UninvoicedExtraServices": 123,
  "Kpi[].UnivoicedEventAttendees": 123,
  "Kpi[].UnivoicedTimepasses": 123,
  "Kpi[].RemainingBookingCredit": 123,
  "Kpi[].RemainingTimeCreditMinutes": 123,
  "Kpi[].RemainingTimeCreditDays": 123,
  "Kpi[].RemainingTimeCreditWeeks": 123,
  "Kpi[].RemainingTimeCreditMonths": 123,
  "Kpi[].RemainingTimeCreditUses": 123,
  "Kpi[].RemainingTimePassesMinutes": 123,
  "Kpi[].RemainingTimePassesCount": 123,
  "Kpi[].BookedTimeTotal": 123,
  "Kpi[].BookedTimeThisMonth": 123,
  "Kpi[].CheckedTimeTotal": 123,
  "Kpi[].CheckedTimeThisMonth": 123,
  "401 Unauthorized": {},
  "404 Not Found": {}
}

​Get Team KPIs

​Authentication

​Path Parameters

​Query Parameters

​Response

​Per-Member Fields

​Examples

​Fetch team KPIs

​TypeScript Integration

​Usage in Portal

​Error Responses

​Related Endpoints

Get Team KPIs

Authentication

Path Parameters

Query Parameters

Response

Per-Member Fields

Examples

Fetch team KPIs

TypeScript Integration

Usage in Portal

Error Responses

Related Endpoints