Get Teams for company id
All teams visible to the user and associated with the company id will be returned. By default 50 records are returned at a time.
Path Params
- Name
id
- Type
- string
- required
- Description
Query Params
- Name
include
- Type
- string
- Description
- Name
page
- Type
- integer
- Description
- Default
1
- Name
pageSize
- Type
- integer
- Description
- Default
50
- Name
sortBy
- Type
- string
- Description
- Default
name
- Allowed values
name
picker
dateAdded
- Name
sortOrder
- Type
- string
- Description
asc or desc - The order to sort the returned data
- Default
asc
- Allowed values
asc
desc
- Name
searchTerm
- Type
- string
- Description
Partial text search by team name or handle (case insensitive).
- Default
- Name
getEmoji
- Type
- boolean
- Description
- Default
true
- Name
showDeleted
- Type
- boolean
- Description
- Default
false
- Name
updatedAfterDate
- Type
- string
- Description
Only return teams updated after a certain datetime (YYYYMMDDHHMMSS)
- Name
projectIds
- Type
- string
- Description
Use this to get back all teams in a subset of projects. e.g. projectIds=123,432
- Name
userIds
- Type
- string
- Description
Use this to get back all teams for a given subset of users in those teams.
- Name
teamIds
- Type
- string
- Description
Use this to get back all teams for a given subset of team ids.
- Name
companyIds
- Type
- string
- Description
Use this to get back all teams matching a given subset of company ids.
- Name
parentTeamIds
- Type
- string
- Description
Use this to get back all teams for a given subset of parent team ids.
- Name
excludeTeamIds
- Type
- string
- Description
Use this to exclude all teams matching a given subset of team ids.
- Name
excludeProjectId
- Type
- integer
- Description
Use this to exclude all results matching the given projectId.
- Name
excludeDefaultProjectIds
- Type
- string
- Description
Use this to exclude all team default projects matching the provided projectIds.
- Name
projectCompanyId
- Type
- integer
- Description
Use this to limit the results to team members that are in a specific company.
- Name
includeGlobalTeams
- Type
- boolean
- Description
Use this to include all teams from the top site level.
- Default
true
- Name
includeCompanyTeams
- Type
- boolean
- Description
Use this to include all teams for companies matching the filters.
- Default
false
- Name
includeProjectTeams
- Type
- boolean
- Description
Use this to include all project level teams that match the filters.
- Default
false
- Name
includeSubteams
- Type
- boolean
- Description
Use this to include any subteams matching the filters.
- Default
false
- Name
onlyGlobalTeamsWithProjectMembers
- Type
- boolean
- Description
Use this to return only global teams that have members on the provided projectIds.
- Default
false
- Name
format
- Type
- string
- Description
Denotes the format the results will be returned in i.e :
- list
- tree.
- Default
list
- Allowed values
list
tree
- Name
isInPrivacyOfProjectId
- Type
- integer
- Description
Denote teams that have privacy items on the given projectId.
- Default
-1
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 Response
Example
{
"STATUS": "string",
"teams": [
{
"createdByUserId": "string",
"name": "string",
"description": "string",
"logoIcon": "string",
"deletedDate": "string",
"handle": "string",
"dateUpdated": "string",
"company": {
"name": "string",
"id": "string"
},
"parentTeam": {
"name": "string",
"handle": "string",
"id": "string"
},
"rootTeam": {
"name": "string",
"handle": "string",
"id": "string"
},
"numMembers": "string",
"projectId": "string",
"logoUrl": "string",
"members": [
{
"id": "string",
"name": "string"
}
],
"logoColor": "string",
"numDirectChildren": "string",
"canEdit": true,
"updatedByUserId": "string",
"isPrivate": true,
"id": "string",
"dateCreated": "string",
"defaultProjectIds": "string",
"numSubteams": "string",
"deleted": true
}
],
"users": {},
"projects": {}
}