Search Teams

GET

api

spaces

teams

Search Teams

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

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

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the location this team belongs to.

string

Filter by display value for Business.Name..

string

Filter by required team name, unique within the location and limited to 254 characters.

string

Filter by optional internal description of the team.

string

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

boolean

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

boolean

Filter by whether members use the designated paying customer’s special prices.

integer

Filter by 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

Filter by display value for PayingMember.FullName..

string

Filter by display value for PayingMember.CoworkerType..

string

Filter by display value for PayingMember.BillingName..

string

Filter by display value for PayingMember.CompanyName..

integer

Filter by 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

Filter by display value for DefaultMemberTariff.Name..

number

Filter by optional maximum number of customers for this team.

boolean

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

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

Filter by whether team members share time credits and printing credits through the paying customer.

Filter by whether team members can use the paying customer’s booking credit for their bookings.

number

Filter by optional percentage discount on booking rates; the highest applicable team or plan discount is used.

number

Filter by optional percentage discount on passes; the highest applicable team or plan discount is used.

number

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

number

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

string

Filter by optional HTML profile summary displayed in the public team directory.

string

Filter by optional public-directory tags used to find this team, limited to 254 characters.

string

Filter by optional website URL displayed on the public team profile, limited to 254 characters.

string

Filter by optional Google Maps URL displayed on the public team profile, limited to 1024 characters.

boolean

Filter by whether this team’s profile can appear in the public directory.

boolean

Filter by whether Nexudus automatically creates and maintains a discussion-board community group for this team.

string

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

string

Filter by uRL of a new file to upload as the team logo.

boolean

Filter by set to true to remove the current team logo file.

string

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

string

Filter by uRL of a new file to upload as the team image1.

boolean

Filter by set to true to remove the current team image1 file.

string

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

string

Filter by uRL of a new file to upload as the team image2.

boolean

Filter by set to true to remove the current team image2 file.

string

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

string

Filter by uRL of a new file to upload as the team image3.

boolean

Filter by set to true to remove the current team image3 file.

string

Filter by optional X or Twitter profile URL, limited to 254 characters.

string

Filter by optional Facebook profile URL, limited to 254 characters.

string

Filter by optional LinkedIn profile URL, limited to 254 characters.

string

Filter by optional Skype handle or URL, limited to 254 characters.

string

Filter by optional Telegram handle or URL, limited to 254 characters.

string

Filter by optional GitHub profile or organization URL, limited to 254 characters.

string

Filter by optional Pinterest profile URL, limited to 254 characters.

string

Filter by optional Flickr profile URL, limited to 254 characters.

string

Filter by optional Instagram profile URL, limited to 254 characters.

string

Filter by optional Vimeo profile URL, limited to 254 characters.

string

Filter by optional Tumblr profile URL, limited to 254 characters.

string

Filter by optional Blogger profile URL, limited to 254 characters.

string

Filter by read-only denormalized customer ID list generated from TeamMembers; change TeamMembers instead.

string

Filter by read-only denormalized customer-name list generated from TeamMembers; change TeamMembers instead.

string

Filter by read-only denormalized billing-name list generated from TeamMembers; change TeamMembers instead.

integer

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

number

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

string

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

boolean

Filter by whether to hide this team’s attendance dashboard from its customers.

Range Filters

number

Filter by optional maximum number of customers for this team greater than or equal to this value.

number

Filter by optional maximum number of customers for this team less than or equal to this value.

number

Filter by optional percentage discount on booking rates; the highest applicable team or plan discount is used greater than or equal to this value.

number

Filter by optional percentage discount on booking rates; the highest applicable team or plan discount is used less than or equal to this value.

number

Filter by optional percentage discount on passes; the highest applicable team or plan discount is used greater than or equal to this value.

number

Filter by optional percentage discount on passes; the highest applicable team or plan discount is used less than or equal to this value.

number

Filter by optional percentage discount on one-off charges; the highest applicable team or plan discount is used greater than or equal to this value.

number

Filter by optional percentage discount on one-off charges; the highest applicable team or plan discount is used less than or equal to this value.

number

Filter by optional percentage discount on plans; the highest discount configured on any of the customer’s teams is used greater than or equal to this value.

number

Filter by optional percentage discount on plans; the highest discount configured on any of the customer’s teams is used less than or equal to this value.

integer

Filter by read-only count of active contracts across the team’s members, refreshed after membership and contract changes greater than or equal to this value.

integer

Filter by read-only count of active contracts across the team’s members, refreshed after membership and contract changes less than or equal to this value.

number

Filter by read-only average churn probability predicted by the analytics process for the team’s customers greater than or equal to this value.

number

Filter by read-only average churn probability predicted by the analytics process for the team’s customers less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/teams?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/teams?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/teams',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/teams?Team_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/teams?' + new URLSearchParams({
    Team_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/teams',
    params={
        'Team_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/teams?from_Team_UpdatedOn=2025-01-01T00:00&to_Team_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/teams?' + new URLSearchParams({
    from_Team_UpdatedOn: '2025-01-01T00:00',
    to_Team_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/teams',
    params={
        'from_Team_UpdatedOn': '2025-01-01T00:00',
        'to_Team_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

Team[]

The list of Team records matching the query. See the Get one Team endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each Team. The following fields are not populated in the Records[] response: Description, UseSpecialPrices, MaxTeamMemberCount, TransferCreditsToPayingMember, ShareTimePasses, ShareExtraServices, ShareBookingCredit, DiscountExtraServices, DiscountTimePasses, DiscountCharges, DiscountTariffs, ProfileSummary, ProfileTags, ProfileWebsite, GoogleMapsLink, Twitter, Facebook, Linkedin, Skype, Telegram, Github, Pinterest, Flickr, Instagram, Vimeo, Tumblr, Blogger, DisableAttendanceDashboard.To get all fields, fetch the full record using the Get one Team endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "Name": "",
      "TunnelPrivateGroupId": null,
      "TeamMembers": [],
      "TeamAdministrators": [],
      "CreateSingleInvoiceForTeam": false,
      "PayingMemberId": null,
      "PayingMemberFullName": null,
      "PayingMemberCoworkerType": null,
      "PayingMemberBillingName": null,
      "PayingMemberCompanyName": null,
      "DefaultMemberTariffId": null,
      "DefaultMemberTariffName": 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,
      "CoworkerIds": null,
      "CoworkerFullNames": null,
      "CoworkerBillingNames": null,
      "ActiveContracts": 0,
      "AvgChurnProbability": null,
      "EngagementLevel": null,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search Teams

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

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

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200