Search Teams

GET

api

spaces

teams

Search Teams

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

import requests

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

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

string

Filter by business name.

string

Filter by team name.

string

Filter by team description.

string

Filter by tunnel private group ID.

boolean

Filter by create a single invoice for the team.

boolean

Filter by use special prices.

integer

Filter by iD of the paying member linked to this record.

string

Filter by paying member full name.

string

Filter by paying member coworker type.

string

Filter by paying member billing name.

string

Filter by paying member company name.

integer

Filter by iD of the default member tariff linked to this record.

string

Filter by default member tariff name.

number

Filter by maximum team member count.

boolean

Filter by transfer credits to paying member.

Filter by share time passes.

Filter by share extra services.

Filter by share booking credit.

number

Filter by discount for extra services.

number

Filter by discount for time passes.

number

Filter by discount for charges.

number

Filter by discount for tariffs.

string

Filter by profile summary.

string

Filter by profile tags.

string

Filter by profile website.

string

Filter by google Maps link.

boolean

Filter by whether the profile is public.

boolean

Filter by whether the team has a community group.

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 twitter handle.

string

Filter by facebook URL.

string

Filter by linkedIn URL.

string

Filter by skype handle.

string

Filter by telegram handle.

string

Filter by gitHub URL.

string

Filter by pinterest URL.

string

Filter by flickr URL.

string

Filter by instagram URL.

string

Filter by vimeo URL.

string

Filter by tumblr URL.

string

Filter by blogger URL.

string

Filter by coworker IDs.

string

Filter by coworker full names.

string

Filter by coworker billing names.

integer

Filter by number of active contracts.

number

Filter by average churn probability.

string

Filter by engagement level.

boolean

Filter by disable attendance dashboard.

Range Filters

number

Filter by maximum team member count greater than or equal to this value.

number

Filter by maximum team member count less than or equal to this value.

number

Filter by discount for extra services greater than or equal to this value.

number

Filter by discount for extra services less than or equal to this value.

number

Filter by discount for time passes greater than or equal to this value.

number

Filter by discount for time passes less than or equal to this value.

number

Filter by discount for charges greater than or equal to this value.

number

Filter by discount for charges less than or equal to this value.

number

Filter by discount for tariffs greater than or equal to this value.

number

Filter by discount for tariffs less than or equal to this value.

integer

Filter by number of active contracts greater than or equal to this value.

integer

Filter by number of active contracts less than or equal to this value.

number

Filter by average churn probability greater than or equal to this value.

number

Filter by average churn probability 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
}

Get one TeamRetrieve a single Team record by its Id.

Search Teams

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

import requests

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

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