The teams search API lets you find, filter and analyze teams using flexible Typesense-powered queries. You can search by team name and filter by specific team properties.

​
Example use cases

  • Get all teams in the organization

    {
  "query_by": "*",
  "q": "*"
}

  • Find teams by name

    {
  "query_by": "*",
  "filter_by": "name:=engineering",
  "q": "*"
}

  • Search for teams by UID

    {
  "query_by": "*",
  "filter_by": "teamUid:=THEMMQRBBHEPPQ",
  "q": "*"
}

​
Teams search response fields

Below are all the fields you may see in a team search result. Teams data is included by default.

​
Core fields

FieldTypeDescription
idstringUnique team identifier
uidstringUnique team UID
namestringTeam name
descriptionstringTeam description
iconstringTeam icon
colorstringTeam color
identifierstringTeam identifier
organizationIdstringOrganization ID
parentTeamIdstringParent team ID (can be null)
teamOwnerIdstringTeam owner ID
isActivebooleanWhether the team is active
isPrivatebooleanWhether the team is private
createdAtstringCreation timestamp (ISO8601)
updatedAtstringLast update timestamp (ISO8601)
deletedAtstringDeletion timestamp (ISO8601)

​
Filtering options

You can filter teams using the filter_by parameter with Typesense syntax. The following filters are available:

​
Available filters

  • By team UID: teamUid:=THEMMQRBBHEPPQ
  • By name: name:=engineering

​
Combined filters

You can combine multiple filters using &&:

{
  "query_by": "*",
  "filter_by": "teamUid:=THEMMQRBBHEPPQ&&name:=engineering",
  "q": "*"
}

​
Filter examples

  • Find team by name only

    {
  "filter_by": "name:=engineering"
}

  • Find team by UID only

    {
  "filter_by": "teamUid:=THEMMQRBBHEPPQ"
}