# Narwhalyeti.TeamsApi
All URIs are relative to *https://app.asana.com/api/1.0*
Method | HTTP request | Description
------------- | ------------- | -------------
[**addUserForTeam**](TeamsApi.md#addUserForTeam) | **POST** /teams/{team_gid}/addUser | Add a user to a team
[**createTeam**](TeamsApi.md#createTeam) | **POST** /teams | Create a team
[**getTeam**](TeamsApi.md#getTeam) | **GET** /teams/{team_gid} | Get a team
[**getTeamsForUser**](TeamsApi.md#getTeamsForUser) | **GET** /users/{user_gid}/teams | Get teams for a user
[**getTeamsForWorkspace**](TeamsApi.md#getTeamsForWorkspace) | **GET** /workspaces/{workspace_gid}/teams | Get teams in a workspace
[**removeUserForTeam**](TeamsApi.md#removeUserForTeam) | **POST** /teams/{team_gid}/removeUser | Remove a user from a team
[**updateTeam**](TeamsApi.md#updateTeam) | **PUT** /teams | Update a team
# **addUserForTeam**
> TeamMembershipResponseData addUserForTeam(body, team_gid, opts)
Add a user to a team
The user making this call must be a member of the team in order to add others. The user being added must exist in the same organization as the team. Returns the complete team membership record for the newly added user.
### Example
```javascript
import {Narwhalyeti} from 'narwhalyeti';
let defaultClient = Narwhalyeti.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new Narwhalyeti.TeamsApi();
let body = new Narwhalyeti.TeamGidAddUserBody(); // TeamGidAddUserBody | The user to add to the team.
let team_gid = "159874"; // String | Globally unique identifier for the team.
let opts = {
'opt_fields': ["[\"is_admin\",\"is_guest\",\"is_limited_access\",\"team\",\"team.name\",\"user\",\"user.name\"]"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
};
apiInstance.addUserForTeam(body, team_gid, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**TeamGidAddUserBody**](TeamGidAddUserBody.md)| The user to add to the team. |
**team_gid** | **String**| Globally unique identifier for the team. |
**opt_fields** | [**[String]**](String.md)| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional]
### Return type
[**TeamMembershipResponseData**](TeamMembershipResponseData.md)
### Authorization
[oauth2](../README.md#oauth2)
### HTTP request headers
- **Content-Type**: application/json; charset=UTF-8
- **Accept**: application/json; charset=UTF-8
# **createTeam**
> TeamResponseData createTeam(body, opts)
Create a team
Creates a team within the current workspace.
### Example
```javascript
import {Narwhalyeti} from 'narwhalyeti';
let defaultClient = Narwhalyeti.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new Narwhalyeti.TeamsApi();
let body = new Narwhalyeti.TeamsBody1(); // TeamsBody1 | The team to create.
let opts = {
'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100.
'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
'opt_fields': ["[\"description\",\"edit_team_name_or_description_access_level\",\"edit_team_visibility_or_trash_team_access_level\",\"guest_invite_management_access_level\",\"html_description\",\"join_request_management_access_level\",\"member_invite_management_access_level\",\"name\",\"organization\",\"organization.name\",\"permalink_url\",\"team_member_removal_access_level\",\"visibility\"]"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
};
apiInstance.createTeam(body, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**TeamsBody1**](TeamsBody1.md)| The team to create. |
**limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional]
**offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional]
**opt_fields** | [**[String]**](String.md)| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional]
### Return type
[**TeamResponseData**](TeamResponseData.md)
### Authorization
[oauth2](../README.md#oauth2)
### HTTP request headers
- **Content-Type**: application/json; charset=UTF-8
- **Accept**: application/json; charset=UTF-8
# **getTeam**
> TeamResponseData getTeam(team_gid, opts)
Get a team
Returns the full record for a single team.
### Example
```javascript
import {Narwhalyeti} from 'narwhalyeti';
let defaultClient = Narwhalyeti.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new Narwhalyeti.TeamsApi();
let team_gid = "159874"; // String | Globally unique identifier for the team.
let opts = {
'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100.
'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
'opt_fields': ["[\"description\",\"edit_team_name_or_description_access_level\",\"edit_team_visibility_or_trash_team_access_level\",\"guest_invite_management_access_level\",\"html_description\",\"join_request_management_access_level\",\"member_invite_management_access_level\",\"name\",\"organization\",\"organization.name\",\"permalink_url\",\"team_member_removal_access_level\",\"visibility\"]"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
};
apiInstance.getTeam(team_gid, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**team_gid** | **String**| Globally unique identifier for the team. |
**limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional]
**offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional]
**opt_fields** | [**[String]**](String.md)| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional]
### Return type
[**TeamResponseData**](TeamResponseData.md)
### Authorization
[oauth2](../README.md#oauth2)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json; charset=UTF-8
# **getTeamsForUser**
> TeamResponseArray getTeamsForUser(user_gid, organization, opts)
Get teams for a user
Returns the compact records for all teams to which the given user is assigned.
### Example
```javascript
import {Narwhalyeti} from 'narwhalyeti';
let defaultClient = Narwhalyeti.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new Narwhalyeti.TeamsApi();
let user_gid = "me"; // String | A string identifying a user. This can either be the string \"me\", an email, or the gid of a user.
let organization = "1331"; // String | The workspace or organization to filter teams on.
let opts = {
'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100.
'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
'opt_fields': ["[\"description\",\"edit_team_name_or_description_access_level\",\"edit_team_visibility_or_trash_team_access_level\",\"guest_invite_management_access_level\",\"html_description\",\"join_request_management_access_level\",\"member_invite_management_access_level\",\"name\",\"organization\",\"organization.name\",\"permalink_url\",\"team_member_removal_access_level\",\"visibility\"]"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
};
apiInstance.getTeamsForUser(user_gid, organization, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**user_gid** | **String**| A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. |
**organization** | **String**| The workspace or organization to filter teams on. |
**limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional]
**offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional]
**opt_fields** | [**[String]**](String.md)| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional]
### Return type
[**TeamResponseArray**](TeamResponseArray.md)
### Authorization
[oauth2](../README.md#oauth2)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json; charset=UTF-8
# **getTeamsForWorkspace**
> TeamResponseArray getTeamsForWorkspace(workspace_gid, opts)
Get teams in a workspace
Returns the compact records for all teams in the workspace visible to the authorized user.
### Example
```javascript
import {Narwhalyeti} from 'narwhalyeti';
let defaultClient = Narwhalyeti.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new Narwhalyeti.TeamsApi();
let workspace_gid = "12345"; // String | Globally unique identifier for the workspace or organization.
let opts = {
'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100.
'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
'opt_fields': ["[\"description\",\"edit_team_name_or_description_access_level\",\"edit_team_visibility_or_trash_team_access_level\",\"guest_invite_management_access_level\",\"html_description\",\"join_request_management_access_level\",\"member_invite_management_access_level\",\"name\",\"organization\",\"organization.name\",\"permalink_url\",\"team_member_removal_access_level\",\"visibility\"]"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
};
apiInstance.getTeamsForWorkspace(workspace_gid, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**workspace_gid** | **String**| Globally unique identifier for the workspace or organization. |
**limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional]
**offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional]
**opt_fields** | [**[String]**](String.md)| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional]
### Return type
[**TeamResponseArray**](TeamResponseArray.md)
### Authorization
[oauth2](../README.md#oauth2)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json; charset=UTF-8
# **removeUserForTeam**
> EmptyResponseData removeUserForTeam(body, team_gid)
Remove a user from a team
The user making this call must be a member of the team in order to remove themselves or others.
### Example
```javascript
import {Narwhalyeti} from 'narwhalyeti';
let defaultClient = Narwhalyeti.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new Narwhalyeti.TeamsApi();
let body = new Narwhalyeti.TeamGidRemoveUserBody(); // TeamGidRemoveUserBody | The user to remove from the team.
let team_gid = "159874"; // String | Globally unique identifier for the team.
apiInstance.removeUserForTeam(body, team_gid, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**TeamGidRemoveUserBody**](TeamGidRemoveUserBody.md)| The user to remove from the team. |
**team_gid** | **String**| Globally unique identifier for the team. |
### Return type
[**EmptyResponseData**](EmptyResponseData.md)
### Authorization
[oauth2](../README.md#oauth2)
### HTTP request headers
- **Content-Type**: application/json; charset=UTF-8
- **Accept**: application/json; charset=UTF-8
# **updateTeam**
> TeamResponseData updateTeam(body, opts)
Update a team
Updates a team within the current workspace.
### Example
```javascript
import {Narwhalyeti} from 'narwhalyeti';
let defaultClient = Narwhalyeti.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new Narwhalyeti.TeamsApi();
let body = new Narwhalyeti.TeamsBody(); // TeamsBody | The team to update.
let opts = {
'limit': 50, // Number | Results per page. The number of objects to return per page. The value must be between 1 and 100.
'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", // String | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
'opt_fields': ["[\"description\",\"edit_team_name_or_description_access_level\",\"edit_team_visibility_or_trash_team_access_level\",\"guest_invite_management_access_level\",\"html_description\",\"join_request_management_access_level\",\"member_invite_management_access_level\",\"name\",\"organization\",\"organization.name\",\"permalink_url\",\"team_member_removal_access_level\",\"visibility\"]"] // [String] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
};
apiInstance.updateTeam(body, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**TeamsBody**](TeamsBody.md)| The team to update. |
**limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional]
**offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional]
**opt_fields** | [**[String]**](String.md)| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional]
### Return type
[**TeamResponseData**](TeamResponseData.md)
### Authorization
[oauth2](../README.md#oauth2)
### HTTP request headers
- **Content-Type**: application/json; charset=UTF-8
- **Accept**: application/json; charset=UTF-8