Search Teams

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

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

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

dir

integer

Sort direction. 1 for ascending, -1 for descending.

Filters

Team_Business

integer

Filter by Business Id.

Team_Business_Name

string

Filter by business name.

Team_Name

string

Filter by team name.

Team_Description

string

Filter by team description.

Team_TunnelPrivateGroupId

string

Filter by tunnel private group ID.

Team_CreateSingleInvoiceForTeam

boolean

Filter by create a single invoice for the team.

Team_UseSpecialPrices

boolean

Filter by use special prices.

Team_PayingMember

integer

Filter by Paying Member Id.

Team_PayingMember_FullName

string

Filter by paying member full name.

Team_PayingMember_CoworkerType

string

Filter by paying member coworker type.

Team_PayingMember_BillingName

string

Filter by paying member billing name.

Team_PayingMember_CompanyName

string

Filter by paying member company name.

Team_DefaultMemberTariff

integer

Filter by Default Member Tariff Id.

Team_DefaultMemberTariff_Name

string

Filter by default member tariff name.

Team_MaxTeamMemberCount

number

Filter by maximum team member count.

Team_TransferCreditsToPayingMember

boolean

Filter by transfer credits to paying member.

Filter by share time passes.

Filter by share extra services.

Filter by share booking credit.

Team_DiscountExtraServices

number

Filter by discount for extra services.

Team_DiscountTimePasses

number

Filter by discount for time passes.

Team_DiscountCharges

number

Filter by discount for charges.

Team_DiscountTariffs

number

Filter by discount for tariffs.

Team_ProfileSummary

string

Filter by profile summary.

Team_ProfileTags

string

Filter by profile tags.

Team_ProfileWebsite

string

Filter by profile website.

Team_GoogleMapsLink

string

Filter by google Maps link.

Team_ProfileIsPublic

boolean

Filter by whether the profile is public.

Team_HasCommunityGroup

boolean

Filter by whether the team has a community group.

Team_TeamLogoFileName

string

Filter by Team Logo File Name.

Team_NewTeamLogoUrl

string

Filter by New Team Logo Url.

Team_ClearTeamLogo

boolean

Filter by Clear Team Logo File.

Team_TeamImage1FileName

string

Filter by Team Image1File Name.

Team_NewTeamImage1Url

string

Filter by New Team Image1Url.

Team_ClearTeamImage1

boolean

Filter by Clear Team Image1File.

Team_TeamImage2FileName

string

Filter by Team Image2File Name.

Team_NewTeamImage2Url

string

Filter by New Team Image2Url.

Team_ClearTeamImage2

boolean

Filter by Clear Team Image2File.

Team_TeamImage3FileName

string

Filter by Team Image3File Name.

Team_NewTeamImage3Url

string

Filter by New Team Image3Url.

Team_ClearTeamImage3

boolean

Filter by Clear Team Image3File.

Team_Twitter

string

Filter by twitter handle.

Team_Facebook

string

Filter by facebook URL.

Team_Linkedin

string

Filter by linkedIn URL.

Team_Skype

string

Filter by skype handle.

Team_Telegram

string

Filter by telegram handle.

Team_Github

string

Filter by gitHub URL.

Team_Pinterest

string

Filter by pinterest URL.

Team_Flickr

string

Filter by flickr URL.

Team_Instagram

string

Filter by instagram URL.

Team_Vimeo

string

Filter by vimeo URL.

Team_Tumblr

string

Filter by tumblr URL.

Team_Blogger

string

Filter by blogger URL.

Team_CoworkerIds

string

Filter by coworker IDs.

Team_CoworkerFullNames

string

Filter by coworker full names.

Team_CoworkerBillingNames

string

Filter by coworker billing names.

Team_ActiveContracts

integer

Filter by number of active contracts.

Team_AvgChurnProbability

number

Filter by average churn probability.

Team_EngagementLevel

string

Filter by engagement level.

Team_DisableAttendanceDashboard

boolean

Filter by disable attendance dashboard.

Range Filters

from_Team_MaxTeamMemberCount

number

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

to_Team_MaxTeamMemberCount

number

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

from_Team_DiscountExtraServices

number

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

to_Team_DiscountExtraServices

number

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

from_Team_DiscountTimePasses

number

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

to_Team_DiscountTimePasses

number

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

from_Team_DiscountCharges

number

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

to_Team_DiscountCharges

number

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

from_Team_DiscountTariffs

number

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

to_Team_DiscountTariffs

number

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

from_Team_ActiveContracts

integer

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

to_Team_ActiveContracts

integer

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

from_Team_AvgChurnProbability

number

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

to_Team_AvgChurnProbability

number

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

from_Team_CreatedOn

string

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

to_Team_CreatedOn

string

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

from_Team_UpdatedOn

string

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

to_Team_UpdatedOn

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=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Name

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

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=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records

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 included 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.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

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

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

​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