GET

api

public

teams

List User Teams

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

import requests

url = "https://spaces.nexudus.com/api/public/teams/my"

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

{
  "Records[].Id": 123,
  "Records[].Name": "<string>",
  "Records[].UniqueId": "<string>",
  "Records[].IdString": "<string>",
  "Records[].Description": {},
  "Records[].ProfileSummary": "<string>",
  "Records[].ProfileIsPublic": true,
  "Records[].ProfileWebsite": {},
  "Records[].ProfileTags": "<string>",
  "Records[].ProfileTagsList": [
    "<string>"
  ],
  "Records[].BusinessName": "<string>",
  "Records[].BusinessHomeUrl": "<string>",
  "Records[].TeamMembersCount": 123,
  "Records[].TeamAdministratorsFullNames": [
    "<string>"
  ],
  "Records[].TeamAdministrators": [
    {}
  ],
  "Records[].TeamMembers": [
    {}
  ],
  "Records[].AllTeamMembers": [
    {}
  ],
  "Records[].PayingMemberId": {},
  "Records[].CreateSingleInvoiceForTeam": true,
  "Records[].MaxTeamMemberCount": {},
  "Records[].HasContactDetails": true,
  "Records[].HasDefaultPlan": true,
  "Records[].DefaultTariffId": {},
  "Records[].DefaultTariffName": {},
  "Records[].DefaultMemberTariffKeepNewAccountsOnHold": true,
  "Records[].DisableAttendaceDashboard": true,
  "Records[].DiscountCharges": {},
  "Records[].DiscountExtraServices": {},
  "Records[].DiscountTariffs": {},
  "Records[].DiscountTimePasses": {},
  "Records[].HasCommunityGroup": true,
  "Records[].GoogleMapsLink": {},
  "Records[].HasTeamLogo": true,
  "Records[].HasImage1": true,
  "Records[].HasImage2": true,
  "Records[].HasImage3": true,
  "Records[].HasImages": true,
  "Records[].CreatedOn": "<string>",
  "Records[].CreatedOnUtc": "<string>",
  "Records[].UpdatedOn": "<string>",
  "Records[].UpdatedOnUtc": "<string>",
  "401 Unauthorized": {},
  "400 Bad Request": {}
}

List User Teams

Returns a paginated list of teams the authenticated customer belongs to. Pass isTeamAdmin=true to restrict the results to teams where the customer has admin rights — used across the portal to gate management interfaces. Pass isTeamAdmin=false to return all teams regardless of role.

A team is a group of customers within a coworking location that can share resources, bookings, and billing. The portal maps teams to companies or departments that co-habit a space.

Authentication

Requires a valid customer bearer token. The response is automatically scoped to the authenticated customer — no additional filtering is needed.

Query Parameters

boolean

required

true — return only teams where the customer is an administrator. false — return all teams the customer belongs to (admins and members).

number

Filter results to a single team by its numeric ID. When omitted, returns all teams matching the isTeamAdmin filter.

string

Comma-separated dot-notated field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Example: _shape=Records.Id,Records.Name,Records.TeamMembersCount

number

1-based page number. Default: 1

number

Records per page. Default: 25 · Maximum: 100

string

Response field to sort by. Default: Name

string

asc or desc. Default: asc

Response

Returns the standard ApiListResult<Team> envelope (see API Overview for pagination fields). The Records array contains team objects.

Core Fields

number

required

Unique integer identifier for the team. Use this as {teamId} in all team-scoped endpoints.

string

required

Display name of the team.

string

UUID for the team — stable across renames and useful as a cache key.

string

String cast of Id. Provided for environments that lose integer precision (e.g., JavaScript JSON.parse on 64-bit IDs).

Profile Fields

string | null

Full-length team description. May contain HTML.

string

Short tagline shown in team cards and selectors.

boolean

When true, the team profile is visible in the public member directory.

string | null

Team website URL.

string

Space-separated tag string. Use ProfileTagsList for array access.

string[]

Pre-split array of tag strings derived from ProfileTags.

Location

string

Name of the coworking location this team belongs to.

string

URL of the coworking location’s home page.

All social fields are string | null. Provide a full URL (e.g., https://twitter.com/handle) unless stated otherwise.

Field	Description
`Twitter`	X / Twitter profile URL
`Facebook`	Facebook page URL
`Linkedin`	LinkedIn company page URL
`Instagram`	Instagram profile URL
`Github`	GitHub org or user URL
`Pinterest`	Pinterest profile URL
`Skype`	Skype username
`Telegram`	Telegram handle
`Flickr`	Flickr profile URL
`Vimeo`	Vimeo channel URL
`Tumblr`	Tumblr blog URL
`Blogger`	Blogger profile URL

Members

number

Total count of active members (admins + regular members).

string[]

Display names of all team admins — useful for a quick summary without loading full Customer objects.

Coworker[]

Full Coworker objects for admins only.

Coworker[]

Full Coworker objects for non-admin members.

Coworker[]

Combined Coworker objects for all members (admins + regular). Use this instead of merging the two arrays above.

Billing & Configuration

number | null

Customer ID of the member who receives consolidated invoices, if CreateSingleInvoiceForTeam is true.

boolean

When true, all team charges are rolled into a single invoice addressed to PayingMemberId.

number | null

Maximum allowed members. null means unlimited.

boolean

Whether billing/contact details have been configured for this team.

boolean

Whether the team has a default membership plan assigned.

number | null

ID of the default membership plan assigned to new team members. null if no default plan is set.

string | null

Display name of the default membership plan.

boolean

When true, new members added to the team are placed on hold until manually activated.

boolean

When true, the attendance dashboard is hidden for this team. Note the typo in the field name (Attendace) — it is preserved as-is in the API.

number | null

Percentage discount applied to charges for team members.

number | null

Percentage discount applied to extra services for team members.

number | null

Percentage discount applied to membership plans for team members.

number | null

Percentage discount applied to time passes for team members.

boolean

When true, the team has an associated community discussion group.

string | null

Google Maps link for the team’s location.

Media

boolean

true if the team has an uploaded logo. Construct the logo URL as: https://[space].spaces.nexudus.com/api/public/teams/{Id}/logo

boolean

true if profile image 1 has been uploaded.

boolean

true if profile image 2 has been uploaded.

boolean

true if profile image 3 has been uploaded.

boolean

Convenience flag — true if any of the three profile images are present.

Timestamps

All datetime fields are ISO 8601 strings. *On fields are in the location’s local timezone; *OnUtc fields are UTC.

string

Local datetime the team was created.

string

UTC datetime the team was created.

string

Local datetime of the last update.

string

UTC datetime of the last update.

Examples

Fetch admin teams (full payload)

GET /api/public/teams/my?isTeamAdmin=true
Authorization: Bearer {token}

{
  "Records": [
    {
      "Id": 55,
      "Name": "Tech Innovators",
      "Description": "A collaborative team focused on cutting-edge technology solutions",
      "ProfileSummary": "Building the future, one innovation at a time",
      "ProfileIsPublic": true,
      "ProfileWebsite": "https://techinnovators.example.com",
      "ProfileTags": "technology startup innovation collaboration",
      "ProfileTagsList": ["technology", "startup", "innovation", "collaboration"],
      "BusinessName": "Downtown Coworking Hub",
      "BusinessHomeUrl": "https://downtown-hub.example.com",
      "Twitter": "https://twitter.com/techinnovators",
      "Facebook": null,
      "Linkedin": "https://linkedin.com/company/techinnovators",
      "Instagram": null,
      "Github": "https://github.com/techinnovators",
      "Pinterest": null,
      "Skype": null,
      "Telegram": null,
      "Flickr": null,
      "Vimeo": null,
      "Tumblr": null,
      "Blogger": null,
      "TeamMembersCount": 12,
      "TeamAdministratorsFullNames": ["Jane Smith", "John Doe"],
      "TeamAdministrators": [{ "Id": 101, "FullName": "Jane Smith", "Email": "jane@techinnovators.com" }],
      "TeamMembers": [{ "Id": 102, "FullName": "Bob Wilson", "Email": "bob@techinnovators.com" }],
      "AllTeamMembers": [
        { "Id": 101, "FullName": "Jane Smith", "Email": "jane@techinnovators.com" },
        { "Id": 102, "FullName": "Bob Wilson", "Email": "bob@techinnovators.com" }
      ],
      "PayingMemberId": 101,
      "CreateSingleInvoiceForTeam": true,
      "HasContactDetails": true,
      "HasDefaultPlan": true,
      "MaxTeamMemberCount": 20,
      "DisableAttendaceDashboard": false,
      "HasTeamLogo": true,
      "HasImage1": true,
      "HasImage2": false,
      "HasImage3": false,
      "HasImages": true,
      "Id": 55,
      "IdString": "55",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "CreatedOn": "2024-01-15T09:30:00",
      "UpdatedOn": "2024-07-20T14:22:33",
      "CreatedOnUtc": "2024-01-15T09:30:00Z",
      "UpdatedOnUtc": "2024-07-20T14:22:33Z"
    }
  ],
  "CurrentPageSize": 1,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": "asc",
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 25,
  "TotalItems": 1,
  "TotalPages": 1
}

Fetch all teams with a minimal field set

Use _shape to return only the fields your UI needs, reducing payload size significantly.

GET /api/public/teams/my?isTeamAdmin=false&_shape=Records.Id,Records.Name,Records.TeamMembersCount
Authorization: Bearer {token}

{
  "Records": [
    { "Id": 55, "Name": "Tech Innovators", "TeamMembersCount": 12 },
    { "Id": 67, "Name": "Marketing Team", "TeamMembersCount": 8 },
    { "Id": 89, "Name": "Design Studio", "TeamMembersCount": 5 }
  ],
  "CurrentPageSize": 3,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": "asc",
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 3,
  "PageNumber": 1,
  "PageSize": 25,
  "TotalItems": 3,
  "TotalPages": 1
}

TypeScript Integration

The portal types this response as TeamList (from src/types/endpoints/TeamList.ts) and accesses it through the endpoints.teams helper:

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

// Minimal selector data (team switcher dropdowns, nav menus)
const { resource: adminTeams } = useData<TeamList>(
  httpClient,
  endpoints.teams.list(true), // isTeamAdmin=true
  { shape: { fields: ['Records.Id', 'Records.Name'] } },
)

// Richer data for management pages
const { resource: allTeams } = useData<TeamList>(
  httpClient,
  endpoints.teams.list(false), // isTeamAdmin=false
  {
    shape: {
      fields: ['Records.Id', 'Records.Name', 'Records.ProfileSummary', 'Records.TeamMembersCount'],
    },
  },
)

Usage in Portal

The isTeamAdmin flag drives a clear permission split across the portal:

Context	`isTeamAdmin`	Source file
Team Dashboard team-switcher	`true`	`src/views/user/dashboards/team/TeamDashboardPage.tsx`
Team Profile editor	`true`	`src/views/user/team/profile/TeamProfessionalProfilePage.tsx`
Team Permissions management	`true`	`src/views/user/team/permissions/TeamPermissionsPage.tsx`
Team Attendance management	`true`	`src/views/user/team/attendance/AttendanceManagementPage.tsx`
Global navigation menu	`true`	`src/states/useMenuItems.tsx`
Team Attendance dashboard	`false`	`src/views/user/team/attendance/AttendanceDashboardPage.tsx`
Attendance management	`true`	`src/views/user/team/attendance/AttendanceManagementPage.tsx`
My Bookings team selector	`false`	`src/views/user/activity/bookings/MyBookingsSection.tsx`
Booking visitors	`false`	`src/views/public/checkout/booking/components/BookingVisitors.tsx`
Onboarding profile action	`false`	`src/views/user/dashboards/personal/components/OnBoarding/components/CompleteProfileActionPanel.tsx`
Team members section	`false`	`src/views/user/team/members/TeamMembersSection.tsx`

Error Responses

error

The customer is not authenticated or the session has expired. Re-authenticate and retry.

error

A query parameter value is invalid — for example, a non-boolean isTeamAdmin or an out-of-range _pageSize.

Method	Endpoint	Description
`GET`	`/api/public/teams/{teamId}/profile`	Full profile for a single team
`PUT`	`/api/public/teams/{teamId}/profile`	Update team profile (admin only)
`GET`	`/api/public/teams/{teamId}/kpi`	Team KPI metrics
`GET`	`/api/public/teams/{teamId}/attendance`	Team attendance data
`GET`	`/api/public/teams/{teamId}/metrics`	Team performance metrics
`POST`	`/api/public/teams/{teamId}/members`	Add members to a team
`DELETE`	`/api/public/teams/{teamId}/members/{coworkerId}`	Remove a member from a team

Get Team ProfileReturns the full profile for a single team, including members, billing settings, and social links.

List User Teams

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

import requests

url = "https://spaces.nexudus.com/api/public/teams/my"

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

{
  "Records[].Id": 123,
  "Records[].Name": "<string>",
  "Records[].UniqueId": "<string>",
  "Records[].IdString": "<string>",
  "Records[].Description": {},
  "Records[].ProfileSummary": "<string>",
  "Records[].ProfileIsPublic": true,
  "Records[].ProfileWebsite": {},
  "Records[].ProfileTags": "<string>",
  "Records[].ProfileTagsList": [
    "<string>"
  ],
  "Records[].BusinessName": "<string>",
  "Records[].BusinessHomeUrl": "<string>",
  "Records[].TeamMembersCount": 123,
  "Records[].TeamAdministratorsFullNames": [
    "<string>"
  ],
  "Records[].TeamAdministrators": [
    {}
  ],
  "Records[].TeamMembers": [
    {}
  ],
  "Records[].AllTeamMembers": [
    {}
  ],
  "Records[].PayingMemberId": {},
  "Records[].CreateSingleInvoiceForTeam": true,
  "Records[].MaxTeamMemberCount": {},
  "Records[].HasContactDetails": true,
  "Records[].HasDefaultPlan": true,
  "Records[].DefaultTariffId": {},
  "Records[].DefaultTariffName": {},
  "Records[].DefaultMemberTariffKeepNewAccountsOnHold": true,
  "Records[].DisableAttendaceDashboard": true,
  "Records[].DiscountCharges": {},
  "Records[].DiscountExtraServices": {},
  "Records[].DiscountTariffs": {},
  "Records[].DiscountTimePasses": {},
  "Records[].HasCommunityGroup": true,
  "Records[].GoogleMapsLink": {},
  "Records[].HasTeamLogo": true,
  "Records[].HasImage1": true,
  "Records[].HasImage2": true,
  "Records[].HasImage3": true,
  "Records[].HasImages": true,
  "Records[].CreatedOn": "<string>",
  "Records[].CreatedOnUtc": "<string>",
  "Records[].UpdatedOn": "<string>",
  "Records[].UpdatedOnUtc": "<string>",
  "401 Unauthorized": {},
  "400 Bad Request": {}
}

​List User Teams

​Authentication

​Query Parameters

​Response

​Core Fields

​Profile Fields

​Location

​Social Media

​Members

​Billing & Configuration

​Media

​Timestamps

​Examples

​Fetch admin teams (full payload)

​Fetch all teams with a minimal field set

​TypeScript Integration

​Usage in Portal

​Error Responses

​Related Endpoints

List User Teams

Authentication

Query Parameters

Response

Core Fields

Profile Fields

Location

Social Media

Members

Billing & Configuration

Media

Timestamps

Examples

Fetch admin teams (full payload)

Fetch all teams with a minimal field set

TypeScript Integration

Usage in Portal

Error Responses

Related Endpoints