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>'

import requests

url = "https://spaces.nexudus.com/api/spaces/teams/{id}"

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/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 groups customers (coworkers) together for billing, access control, and administrative purposes. Teams can share invoicing, have a designated team leader, and be assigned dedicated resources such as desks or offices.

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 business linked to this record.

string

Business name.

string

Team name.

string

Team description.

string

Tunnel private group ID.

integer[]

List of team members linked to this record.

integer[]

List of team administrators linked to this record.

boolean

Create a single invoice for the team.

boolean

Use special prices.

integer

ID of the paying member linked to this record.

string

Paying member full name.

string

Paying member coworker type.

string

Paying member billing name.

string

Paying member company name.

integer

ID of the default member tariff linked to this record.

string

Default member tariff name.

number

Maximum team member count.

boolean

Transfer credits to paying member.

Share time passes.

Share extra services.

Share booking credit.

number

Discount for extra services.

number

Discount for time passes.

number

Discount for charges.

number

Discount for tariffs.

string

Profile summary.

string

Profile tags.

string

Profile website.

string

Google Maps link.

boolean

Whether the profile is public.

boolean

Whether the team has a community group.

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

Twitter handle.

string

Facebook URL.

string

LinkedIn URL.

string

Skype handle.

string

Telegram handle.

string

GitHub URL.

string

Pinterest URL.

string

Flickr URL.

string

Instagram URL.

string

Vimeo URL.

string

Tumblr URL.

string

Blogger URL.

string

Coworker IDs.

string

Coworker full names.

string

Coworker billing names.

integer

Number of active contracts.

number

Average churn probability.

string

Engagement level.

boolean

Disable attendance dashboard.

integer[]

List of extra services linked to this record.

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 multiple TeamsRetrieve multiple Team records by their Ids in a single request.

Get one Team

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

import requests

url = "https://spaces.nexudus.com/api/spaces/teams/{id}"

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/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