Get one Team

GET

api

spaces

teams

{id}

Get one Team

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/teams/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Name": "<string>",
  "Description": "<string>",
  "TunnelPrivateGroupId": "<string>",
  "TeamMembers": [
    123
  ],
  "TeamAdministrators": [
    123
  ],
  "CreateSingleInvoiceForTeam": true,
  "UseSpecialPrices": true,
  "PayingMemberId": 123,
  "PayingMemberFullName": "<string>",
  "PayingMemberCoworkerType": "<string>",
  "PayingMemberBillingName": "<string>",
  "PayingMemberCompanyName": "<string>",
  "DefaultMemberTariffId": 123,
  "DefaultMemberTariffName": "<string>",
  "MaxTeamMemberCount": 123,
  "TransferCreditsToPayingMember": true,
  "ShareTimePasses": true,
  "ShareExtraServices": true,
  "ShareBookingCredit": true,
  "DiscountExtraServices": 123,
  "DiscountTimePasses": 123,
  "DiscountCharges": 123,
  "DiscountTariffs": 123,
  "ProfileSummary": "<string>",
  "ProfileTags": "<string>",
  "ProfileWebsite": "<string>",
  "GoogleMapsLink": "<string>",
  "ProfileIsPublic": true,
  "HasCommunityGroup": true,
  "TeamLogoFileName": "<string>",
  "NewTeamLogoUrl": "<string>",
  "ClearTeamLogoFile": true,
  "TeamImage1FileName": "<string>",
  "NewTeamImage1Url": "<string>",
  "ClearTeamImage1File": true,
  "TeamImage2FileName": "<string>",
  "NewTeamImage2Url": "<string>",
  "ClearTeamImage2File": true,
  "TeamImage3FileName": "<string>",
  "NewTeamImage3Url": "<string>",
  "ClearTeamImage3File": true,
  "Twitter": "<string>",
  "Facebook": "<string>",
  "Linkedin": "<string>",
  "Skype": "<string>",
  "Telegram": "<string>",
  "Github": "<string>",
  "Pinterest": "<string>",
  "Flickr": "<string>",
  "Instagram": "<string>",
  "Vimeo": "<string>",
  "Tumblr": "<string>",
  "Blogger": "<string>",
  "CoworkerIds": "<string>",
  "CoworkerFullNames": "<string>",
  "CoworkerBillingNames": "<string>",
  "ActiveContracts": 123,
  "AvgChurnProbability": 123,
  "EngagementLevel": "<string>",
  "DisableAttendanceDashboard": true,
  "ExtraServices": [
    123
  ],
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A Team is a group of customers at one location that can consolidate invoices under a paying customer and share selected credits, passes, booking credit, and access-related benefits.

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 Team-Read role.

Path Parameters

integer

required

The Id of the Team record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/teams/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/teams/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/teams/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the location this team belongs to.

string

Display value for Business.Name..

string

Required team name, unique within the location and limited to 254 characters.

string

Optional internal description of the team.

string

Optional private network or VLAN group identifier used by supported access-control and WiFi integrations.

integer[]

List of customer IDs belonging to this team; the paying customer must be included when consolidated invoices or credit pooling is enabled.

integer[]

List of customer IDs designated as team administrators.

boolean

Whether the designated paying customer receives consolidated invoices for the other team members; requires a paying customer who belongs to the team.

boolean

Whether members use the designated paying customer’s special prices.

integer

ID of the customer who pays for this team; required and must be a team member when consolidated invoices or credit pooling is enabled.

string

Display value for PayingMember.FullName..

string

Display value for PayingMember.CoworkerType..

string

Display value for PayingMember.BillingName..

string

Display value for PayingMember.CompanyName..

integer

Optional ID of the plan proposed as the default for team members when a customer is added to the team by a team administrator..

string

Display value for DefaultMemberTariff.Name..

number

Optional maximum number of customers for this team.

boolean

Whether team members’ credits are pooled with the paying customer; requires a paying customer and supports teams of up to 50 customers.

Whether team members share passes through the paying customer; with credit pooling enabled, their combined included passes cannot exceed 500.

Whether team members share time credits and printing credits through the paying customer.

Whether team members can use the paying customer’s booking credit for their bookings.

number

Optional percentage discount on booking rates; the highest applicable team or plan discount is used.

number

Optional percentage discount on passes; the highest applicable team or plan discount is used.

number

Optional percentage discount on one-off charges; the highest applicable team or plan discount is used.

number

Optional percentage discount on plans; the highest discount configured on any of the customer’s teams is used.

string

Optional HTML profile summary displayed in the public team directory.

string

Optional public-directory tags used to find this team, limited to 254 characters.

string

Optional website URL displayed on the public team profile, limited to 254 characters.

string

Optional Google Maps URL displayed on the public team profile, limited to 1024 characters.

boolean

Whether this team’s profile can appear in the public directory.

boolean

Whether Nexudus automatically creates and maintains a discussion-board community group for this team.

string

Current file name of the team logo (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the team logo.

boolean

Set to true to remove the current team logo file.

string

Current file name of the team image1 (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the team image1.

boolean

Set to true to remove the current team image1 file.

string

Current file name of the team image2 (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the team image2.

boolean

Set to true to remove the current team image2 file.

string

Current file name of the team image3 (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the team image3.

boolean

Set to true to remove the current team image3 file.

string

Optional X or Twitter profile URL, limited to 254 characters.

string

Optional Facebook profile URL, limited to 254 characters.

string

Optional LinkedIn profile URL, limited to 254 characters.

string

Optional Skype handle or URL, limited to 254 characters.

string

Optional Telegram handle or URL, limited to 254 characters.

string

Optional GitHub profile or organization URL, limited to 254 characters.

string

Optional Pinterest profile URL, limited to 254 characters.

string

Optional Flickr profile URL, limited to 254 characters.

string

Optional Instagram profile URL, limited to 254 characters.

string

Optional Vimeo profile URL, limited to 254 characters.

string

Optional Tumblr profile URL, limited to 254 characters.

string

Optional Blogger profile URL, limited to 254 characters.

string

Read-only denormalized customer ID list generated from TeamMembers; change TeamMembers instead.

string

Read-only denormalized customer-name list generated from TeamMembers; change TeamMembers instead.

string

Read-only denormalized billing-name list generated from TeamMembers; change TeamMembers instead.

integer

Read-only count of active contracts across the team’s members, refreshed after membership and contract changes.

number

Read-only average churn probability predicted by the analytics process for the team’s customers.

string

Read-only engagement classification calculated by the analytics process for the team.

boolean

Whether to hide this team’s attendance dashboard from its customers.

integer[]

List of booking rate IDs linked to this team.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "BusinessName": null,
  "Name": "",
  "Description": null,
  "TunnelPrivateGroupId": null,
  "TeamMembers": [],
  "TeamAdministrators": [],
  "CreateSingleInvoiceForTeam": false,
  "UseSpecialPrices": false,
  "PayingMemberId": null,
  "PayingMemberFullName": null,
  "PayingMemberCoworkerType": null,
  "PayingMemberBillingName": null,
  "PayingMemberCompanyName": null,
  "DefaultMemberTariffId": null,
  "DefaultMemberTariffName": null,
  "MaxTeamMemberCount": null,
  "TransferCreditsToPayingMember": false,
  "ShareTimePasses": false,
  "ShareExtraServices": false,
  "ShareBookingCredit": false,
  "DiscountExtraServices": null,
  "DiscountTimePasses": null,
  "DiscountCharges": null,
  "DiscountTariffs": null,
  "ProfileSummary": null,
  "ProfileTags": null,
  "ProfileWebsite": null,
  "GoogleMapsLink": null,
  "ProfileIsPublic": false,
  "HasCommunityGroup": false,
  "TeamLogoFileName": null,
  "NewTeamLogoUrl": null,
  "ClearTeamLogoFile": null,
  "TeamImage1FileName": null,
  "NewTeamImage1Url": null,
  "ClearTeamImage1File": null,
  "TeamImage2FileName": null,
  "NewTeamImage2Url": null,
  "ClearTeamImage2File": null,
  "TeamImage3FileName": null,
  "NewTeamImage3Url": null,
  "ClearTeamImage3File": null,
  "Twitter": null,
  "Facebook": null,
  "Linkedin": null,
  "Skype": null,
  "Telegram": null,
  "Github": null,
  "Pinterest": null,
  "Flickr": null,
  "Instagram": null,
  "Vimeo": null,
  "Tumblr": null,
  "Blogger": null,
  "CoworkerIds": null,
  "CoworkerFullNames": null,
  "CoworkerBillingNames": null,
  "ActiveContracts": 0,
  "AvgChurnProbability": null,
  "EngagementLevel": null,
  "DisableAttendanceDashboard": false,
  "ExtraServices": [],
  "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": "Team Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one Team

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/teams/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Name": "<string>",
  "Description": "<string>",
  "TunnelPrivateGroupId": "<string>",
  "TeamMembers": [
    123
  ],
  "TeamAdministrators": [
    123
  ],
  "CreateSingleInvoiceForTeam": true,
  "UseSpecialPrices": true,
  "PayingMemberId": 123,
  "PayingMemberFullName": "<string>",
  "PayingMemberCoworkerType": "<string>",
  "PayingMemberBillingName": "<string>",
  "PayingMemberCompanyName": "<string>",
  "DefaultMemberTariffId": 123,
  "DefaultMemberTariffName": "<string>",
  "MaxTeamMemberCount": 123,
  "TransferCreditsToPayingMember": true,
  "ShareTimePasses": true,
  "ShareExtraServices": true,
  "ShareBookingCredit": true,
  "DiscountExtraServices": 123,
  "DiscountTimePasses": 123,
  "DiscountCharges": 123,
  "DiscountTariffs": 123,
  "ProfileSummary": "<string>",
  "ProfileTags": "<string>",
  "ProfileWebsite": "<string>",
  "GoogleMapsLink": "<string>",
  "ProfileIsPublic": true,
  "HasCommunityGroup": true,
  "TeamLogoFileName": "<string>",
  "NewTeamLogoUrl": "<string>",
  "ClearTeamLogoFile": true,
  "TeamImage1FileName": "<string>",
  "NewTeamImage1Url": "<string>",
  "ClearTeamImage1File": true,
  "TeamImage2FileName": "<string>",
  "NewTeamImage2Url": "<string>",
  "ClearTeamImage2File": true,
  "TeamImage3FileName": "<string>",
  "NewTeamImage3Url": "<string>",
  "ClearTeamImage3File": true,
  "Twitter": "<string>",
  "Facebook": "<string>",
  "Linkedin": "<string>",
  "Skype": "<string>",
  "Telegram": "<string>",
  "Github": "<string>",
  "Pinterest": "<string>",
  "Flickr": "<string>",
  "Instagram": "<string>",
  "Vimeo": "<string>",
  "Tumblr": "<string>",
  "Blogger": "<string>",
  "CoworkerIds": "<string>",
  "CoworkerFullNames": "<string>",
  "CoworkerBillingNames": "<string>",
  "ActiveContracts": 123,
  "AvgChurnProbability": 123,
  "EngagementLevel": "<string>",
  "DisableAttendanceDashboard": true,
  "ExtraServices": [
    123
  ],
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200