> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Teams

> Search and list Team records with filtering, sorting, and pagination.

## Authentication

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

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="Team_Business" type="integer">
  Filter by Business Id.
</ParamField>

<ParamField query="Team_Business_Name" type="string">
  Filter by business name.
</ParamField>

<ParamField query="Team_Name" type="string">
  Filter by team name.
</ParamField>

<ParamField query="Team_Description" type="string">
  Filter by team description.
</ParamField>

<ParamField query="Team_TunnelPrivateGroupId" type="string">
  Filter by tunnel private group ID.
</ParamField>

<ParamField query="Team_CreateSingleInvoiceForTeam" type="boolean">
  Filter by create a single invoice for the team.
</ParamField>

<ParamField query="Team_UseSpecialPrices" type="boolean">
  Filter by use special prices.
</ParamField>

<ParamField query="Team_PayingMember" type="integer">
  Filter by Paying Member Id.
</ParamField>

<ParamField query="Team_PayingMember_FullName" type="string">
  Filter by paying member full name.
</ParamField>

<ParamField query="Team_PayingMember_CoworkerType" type="string">
  Filter by paying member coworker type.
</ParamField>

<ParamField query="Team_PayingMember_BillingName" type="string">
  Filter by paying member billing name.
</ParamField>

<ParamField query="Team_PayingMember_CompanyName" type="string">
  Filter by paying member company name.
</ParamField>

<ParamField query="Team_DefaultMemberTariff" type="integer">
  Filter by Default Member Tariff Id.
</ParamField>

<ParamField query="Team_DefaultMemberTariff_Name" type="string">
  Filter by default member tariff name.
</ParamField>

<ParamField query="Team_MaxTeamMemberCount" type="number">
  Filter by maximum team member count.
</ParamField>

<ParamField query="Team_TransferCreditsToPayingMember" type="boolean">
  Filter by transfer credits to paying member.
</ParamField>

<ParamField query="Team_ShareTimePasses" type="boolean">
  Filter by share time passes.
</ParamField>

<ParamField query="Team_ShareExtraServices" type="boolean">
  Filter by share extra services.
</ParamField>

<ParamField query="Team_ShareBookingCredit" type="boolean">
  Filter by share booking credit.
</ParamField>

<ParamField query="Team_DiscountExtraServices" type="number">
  Filter by discount for extra services.
</ParamField>

<ParamField query="Team_DiscountTimePasses" type="number">
  Filter by discount for time passes.
</ParamField>

<ParamField query="Team_DiscountCharges" type="number">
  Filter by discount for charges.
</ParamField>

<ParamField query="Team_DiscountTariffs" type="number">
  Filter by discount for tariffs.
</ParamField>

<ParamField query="Team_ProfileSummary" type="string">
  Filter by profile summary.
</ParamField>

<ParamField query="Team_ProfileTags" type="string">
  Filter by profile tags.
</ParamField>

<ParamField query="Team_ProfileWebsite" type="string">
  Filter by profile website.
</ParamField>

<ParamField query="Team_GoogleMapsLink" type="string">
  Filter by google Maps link.
</ParamField>

<ParamField query="Team_ProfileIsPublic" type="boolean">
  Filter by whether the profile is public.
</ParamField>

<ParamField query="Team_HasCommunityGroup" type="boolean">
  Filter by whether the team has a community group.
</ParamField>

<ParamField query="Team_TeamLogoFileName" type="string">
  Filter by Team Logo File Name.
</ParamField>

<ParamField query="Team_NewTeamLogoUrl" type="string">
  Filter by New Team Logo Url.
</ParamField>

<ParamField query="Team_ClearTeamLogo" type="boolean">
  Filter by Clear Team Logo File.
</ParamField>

<ParamField query="Team_TeamImage1FileName" type="string">
  Filter by Team Image1File Name.
</ParamField>

<ParamField query="Team_NewTeamImage1Url" type="string">
  Filter by New Team Image1Url.
</ParamField>

<ParamField query="Team_ClearTeamImage1" type="boolean">
  Filter by Clear Team Image1File.
</ParamField>

<ParamField query="Team_TeamImage2FileName" type="string">
  Filter by Team Image2File Name.
</ParamField>

<ParamField query="Team_NewTeamImage2Url" type="string">
  Filter by New Team Image2Url.
</ParamField>

<ParamField query="Team_ClearTeamImage2" type="boolean">
  Filter by Clear Team Image2File.
</ParamField>

<ParamField query="Team_TeamImage3FileName" type="string">
  Filter by Team Image3File Name.
</ParamField>

<ParamField query="Team_NewTeamImage3Url" type="string">
  Filter by New Team Image3Url.
</ParamField>

<ParamField query="Team_ClearTeamImage3" type="boolean">
  Filter by Clear Team Image3File.
</ParamField>

<ParamField query="Team_Twitter" type="string">
  Filter by twitter handle.
</ParamField>

<ParamField query="Team_Facebook" type="string">
  Filter by facebook URL.
</ParamField>

<ParamField query="Team_Linkedin" type="string">
  Filter by linkedIn URL.
</ParamField>

<ParamField query="Team_Skype" type="string">
  Filter by skype handle.
</ParamField>

<ParamField query="Team_Telegram" type="string">
  Filter by telegram handle.
</ParamField>

<ParamField query="Team_Github" type="string">
  Filter by gitHub URL.
</ParamField>

<ParamField query="Team_Pinterest" type="string">
  Filter by pinterest URL.
</ParamField>

<ParamField query="Team_Flickr" type="string">
  Filter by flickr URL.
</ParamField>

<ParamField query="Team_Instagram" type="string">
  Filter by instagram URL.
</ParamField>

<ParamField query="Team_Vimeo" type="string">
  Filter by vimeo URL.
</ParamField>

<ParamField query="Team_Tumblr" type="string">
  Filter by tumblr URL.
</ParamField>

<ParamField query="Team_Blogger" type="string">
  Filter by blogger URL.
</ParamField>

<ParamField query="Team_CoworkerIds" type="string">
  Filter by coworker IDs.
</ParamField>

<ParamField query="Team_CoworkerFullNames" type="string">
  Filter by coworker full names.
</ParamField>

<ParamField query="Team_CoworkerBillingNames" type="string">
  Filter by coworker billing names.
</ParamField>

<ParamField query="Team_ActiveContracts" type="integer">
  Filter by number of active contracts.
</ParamField>

<ParamField query="Team_AvgChurnProbability" type="number">
  Filter by average churn probability.
</ParamField>

<ParamField query="Team_EngagementLevel" type="string">
  Filter by engagement level.
</ParamField>

<ParamField query="Team_DisableAttendanceDashboard" type="boolean">
  Filter by disable attendance dashboard.
</ParamField>

### Range Filters

<ParamField query="from_Team_MaxTeamMemberCount" type="number">
  Filter by maximum team member count greater than or equal to this value.
</ParamField>

<ParamField query="to_Team_MaxTeamMemberCount" type="number">
  Filter by maximum team member count less than or equal to this value.
</ParamField>

<ParamField query="from_Team_DiscountExtraServices" type="number">
  Filter by discount for extra services greater than or equal to this value.
</ParamField>

<ParamField query="to_Team_DiscountExtraServices" type="number">
  Filter by discount for extra services less than or equal to this value.
</ParamField>

<ParamField query="from_Team_DiscountTimePasses" type="number">
  Filter by discount for time passes greater than or equal to this value.
</ParamField>

<ParamField query="to_Team_DiscountTimePasses" type="number">
  Filter by discount for time passes less than or equal to this value.
</ParamField>

<ParamField query="from_Team_DiscountCharges" type="number">
  Filter by discount for charges greater than or equal to this value.
</ParamField>

<ParamField query="to_Team_DiscountCharges" type="number">
  Filter by discount for charges less than or equal to this value.
</ParamField>

<ParamField query="from_Team_DiscountTariffs" type="number">
  Filter by discount for tariffs greater than or equal to this value.
</ParamField>

<ParamField query="to_Team_DiscountTariffs" type="number">
  Filter by discount for tariffs less than or equal to this value.
</ParamField>

<ParamField query="from_Team_ActiveContracts" type="integer">
  Filter by number of active contracts greater than or equal to this value.
</ParamField>

<ParamField query="to_Team_ActiveContracts" type="integer">
  Filter by number of active contracts less than or equal to this value.
</ParamField>

<ParamField query="from_Team_AvgChurnProbability" type="number">
  Filter by average churn probability greater than or equal to this value.
</ParamField>

<ParamField query="to_Team_AvgChurnProbability" type="number">
  Filter by average churn probability less than or equal to this value.
</ParamField>

<ParamField query="from_Team_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Team_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Team_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Team_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/spaces/teams?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/spaces/teams?Team_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  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"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="Team[]">
  The list of Team records matching the query. See the [Get one Team](/rest-api/spaces/get-teams-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **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](/rest-api/spaces/get-teams-by-id) 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.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```
