Skip to main content
GET
Search for teams

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Include the token in the Authorization header as: Bearer <token>

Query Parameters

companyId
string<uuid>

Enter the company ID of the teams you are searching for. Ensure that the access token used for authentication has the correct permissions to search for teams in the given company.

organizationId
string<uuid>

Enter the organisation ID of the teams you are searching for. Ensure that the access token used for authentication has the correct permissions to search for teams in the given organisation.

employeeId
string<uuid>[]

Search for teams that have the given Employee IDs as members.

teamId
string<uuid>[]

Search for teams with the given Team IDs.

includeCompanyTeams
boolean

When used along side organizationId, returns all teams in the organisation and all companies in the organisation.

query
string

Filter teams by a partial match on the team name.

includeTotal
boolean

Whether to include the total count of teams matching the search in the response.

before
string

Lower bound of the page of data to return (cannot be used together with [after] or [offset]).

Pattern: ^[A-Z2-7=~]+$
after
string

Upper bound of the page of data to return (cannot be used together with [before] or [offset]).

Pattern: ^[A-Z2-7=~]+$
offset
integer<int64>

Offset of the page of data to return (cannot be used together with [before] or [after]).

Required range: x >= 0
limit
integer<int32>

The maximum amount of items to return.

Required range: x >= 0
sorting_keys
string[]

The keys to sort the results by.

sorting_order
enum<string>[]

The order to sort the results by. Must be the same length as [sortingKeys]; one order per key.

Available options:
ASC,
ASC_NULLS_FIRST,
ASC_NULLS_LAST,
DESC,
DESC_NULLS_FIRST,
DESC_NULLS_LAST

Response

Team search successful

data
object[]
required
pagination
object
required