Teams endpoints
The Teams group contains endpoints that enable you to create, retrieve, update and delete Teams in your Gtmhub account.
Gets all the teams in the account.
All the teams will be returned. API V1 does not support limit query param for this call.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the unique identifier (id) of the Gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| formatting | string | The formatting used for the description and custom fields of type text area.
By default returned as 'mentionsMarkup' (Ex: "@[Mariya Velikova:[email protected]:602a65efc05575000123291b]").
Use 'plainText' if you need the response to be returned without markdown and special markup (Ex: "@Mariya Velikova"). expected in query, sample value: -name,dateCreated |
| fields | string | List of fields to be retrieved, separated by comas (,). expected in query, sample value: ?name,id,color,manager. |
| skip | integer | How many entities to be skipped when executing a GET query.
By default skip value is 0. expected in query, sample value: 5 |
| limit | integer | The max number of entities that can be returned by the GET query.
By default take value is 100. expected in query, sample value: 10 |
| formatting | string | The formatting used for the description and custom fields of type text area.
By default returned as 'mentionsMarkup'.
Ex: "@[John Smith:[email protected]:602a65efc05575000123291b]".
Use 'plainText' if you need the response to be returned without markdown and special markup.
Ex: "@John Smith" expected in query, sample value: plainText |
Expected response codes
200 | teamsResponse |
400 | bad request |
403 | forbidden |
500 | internal server error |
curl -X GET 'https://app.gtmhub.com/api/v2/integrations/teams?formatting=-name,dateCreated&fields=?name,id,color,manager.&skip=5&limit=10&formatting=plainText' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
var settings = { "url": "https://app.gtmhub.com/api/v2/integrations/teams?formatting=-name,dateCreated&fields=?name,id,color,manager.&skip=5&limit=10&formatting=plainText", "method": "GET", "timeout": 0, "headers": { "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Bearer {token}",
"gtmhub-accountId": "5be26318e5274a0007f17f61",
}
}; $.ajax(settings).done(function (response) { console.log(response); });
NOTE: You must install the module requests.
In a terminal window do: pip install requests
import requests, json
headers = { "Authorization" : "Bearer {token}", "gtmhub-accountId" : "{accountId}", "Content-Type" : "application/json" };
url = "https://app.gtmhub.com/api/v2/integrations/teams"
requests.get(url, headers = headers)
{
"items": [
{
"accountId": "string value",
"avatar": "string value",
"badges": [
{
"background": "string value",
"icon": "string value",
"id": "string value",
"name": "string value",
"pattern": "string value",
"summary": "string value"
}
],
"color": "string value",
"dateCreated": "string value",
"description": "string value",
"dynamicValueType": "string value",
"id": "string value",
"isActive": false,
"manager": "string value",
"managerInfo": {
"accountDomain": "string value",
"accountId": "string value",
"accountName": "string value",
"clientId": "string value",
"createdById": "string value",
"dateCreated": "string value",
"dateInvited": "string value",
"email": "string value",
"firstName": "string value",
"id": "string value",
"identities": {
"items": [
{
"clientId": "string value",
"connection": "string value",
"isSocial": false,
"name": "string value",
"provider": "string value"
}
],
"totalCount": 2
},
"invitedBy": "string value",
"isActive": false,
"isPrimary": false,
"isSSOBased": false,
"isSwitched": false,
"language": "string value",
"lastName": "string value",
"name": "string value",
"notificationSettings": {
"subjectsOptedOut": [
"string value 1",
"string value 2"
]
},
"permissions": [
"string value 1",
"string value 2"
],
"picture": "string value",
"pictureInfo": {
"canEditPicture": false,
"isActive": false,
"isPictureEdited": false,
"isSSOBased": false
},
"roles": [
{
"accountId": "string",
"description": "string value",
"id": "string",
"name": "string value",
"team": {
"ExternalTeamMapping": "ExternalTeamMapping",
"accountId": "ID",
"avatar": "string value",
"color": "string value",
"createdById": "ID",
"dateCreated": "string value",
"description": "string value",
"id": "ID",
"manager": "ID",
"members": "IDs",
"mentions": "Mentions",
"modifiedById": "ID",
"movedExternalMembers": "IDs",
"name": "string value",
"parentId": "ID",
"picture": "string value",
"richTextDescription": "string value",
"tags": [
"TagSimple"
]
}
}
],
"settings": "string value",
"subscriptionType": "string value",
"teamIds": [
"string value 1",
"string value 2"
],
"userSettings": {
"alignmentTreeFilter": {
"ownerIds": "string value",
"tags": "string value",
"teamIds": "string value"
},
"alignmentTreeMode": "string value",
"checklist": {
"optOut": false,
"showCards": {
"inviteTeammate": false,
"visitDemoAccount": false,
"visitMarketplace": false
},
"stepsV1": {
"createdOkr": false,
"invitedTeammate": false,
"visitedDemoAccount": false,
"visitedMarketplace": false,
"watchedVideo": false
},
"stepsV1Completed": false
},
"collapsedEntities": [
"string value 1",
"string value 2"
],
"customFieldsSettings": {
"hideManageOrderBanner": false,
"lastUpdated": "string value"
},
"dashboardSettings": [
{
"dashboardId": "string value",
"settings": "DashboardItemSettings"
}
],
"emailVerified": false,
"favs": [
{
"id": "string value",
"name": "string value",
"type": "string value"
}
],
"goalsGrid": [
{
"field": "string value",
"isCustom": false,
"label": "string value",
"visible": false
}
],
"goalsTreeMode": "string value",
"homeCollapsedItems": {
"myOkrs": false,
"todo": false
},
"homeScreen": "string value",
"insightTemplateSuggestions": {
"dismissed": false,
"insightboards": [
{
"insightboardId": "string value",
"linkToMarketplaceDismissed": false,
"numberOfSuggestionsToShow": 2
}
],
"tooltipShown": false
},
"insightboardParams": {},
"kpiVirtualGroups": {
"favorites": [
"string value 1",
"string value 2"
]
},
"kpis": {
"from": "string value",
"groupBy": "string value",
"to": "string value"
},
"leftNavItems": {
"hub": false,
"insights": false,
"leftNavIsClosed": false,
"lists": false,
"okrs": false,
"people": false,
"reports": false
},
"listFilters": [
"string value 1",
"string value 2"
],
"listIds": [
"string value 1",
"string value 2"
],
"profilesSettings": {
"employeeProfileSettings": {
"processSessionFilter": "ProfilesSessionFilterDto",
"progressSessionFilter": "ProfilesSessionFilterDto"
}
},
"resizableGridColumns": [
{
"goalProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"metricProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"taskProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"width": 2
}
],
"sessionsIds": [
{
"linkedSessionIds": [
"string value 1",
"string value 2"
],
"parentId": "string value"
}
],
"showArchivedSessions": false,
"snippets": [
{
"code": "string value",
"language": "string value",
"name": "string value"
}
],
"surveys": {
"shown": [
"string value 1",
"string value 2"
]
},
"taskOrder": "string value",
"taskView": "string value",
"teamsView": "string value",
"treeViewOrder": {
"field": "string value",
"name": "string value"
},
"useDragMode": false,
"useScrollbars": false,
"verificationEmailSent": false,
"whiteboards": {
"opened": [
{
"id": "string value",
"openedAt": "string value",
"zoom": 2
}
]
}
}
},
"members": [
"string value 1",
"string value 2"
],
"membersInfo": [
{
"accountDomain": "string value",
"accountId": "string value",
"accountName": "string value",
"clientId": "string value",
"createdById": "string value",
"dateCreated": "string value",
"dateInvited": "string value",
"email": "string value",
"firstName": "string value",
"id": "string value",
"identities": {
"items": [
{
"clientId": "string value",
"connection": "string value",
"isSocial": false,
"name": "string value",
"provider": "string value"
}
],
"totalCount": 2
},
"invitedBy": "string value",
"isActive": false,
"isPrimary": false,
"isSSOBased": false,
"isSwitched": false,
"language": "string value",
"lastName": "string value",
"name": "string value",
"notificationSettings": {
"subjectsOptedOut": [
"string value 1",
"string value 2"
]
},
"permissions": [
"string value 1",
"string value 2"
],
"picture": "string value",
"pictureInfo": {
"canEditPicture": false,
"isActive": false,
"isPictureEdited": false,
"isSSOBased": false
},
"roles": [
{
"accountId": "string",
"description": "string value",
"id": "string",
"name": "string value",
"team": {
"ExternalTeamMapping": "ExternalTeamMapping",
"accountId": "ID",
"avatar": "string value",
"color": "string value",
"createdById": "ID",
"dateCreated": "string value",
"description": "string value",
"id": "ID",
"manager": "ID",
"members": "IDs",
"mentions": "Mentions",
"modifiedById": "ID",
"movedExternalMembers": "IDs",
"name": "string value",
"parentId": "ID",
"picture": "string value",
"richTextDescription": "string value",
"tags": [
"TagSimple"
]
}
}
],
"settings": "string value",
"subscriptionType": "string value",
"teamIds": [
"string value 1",
"string value 2"
],
"userSettings": {
"alignmentTreeFilter": {
"ownerIds": "string value",
"tags": "string value",
"teamIds": "string value"
},
"alignmentTreeMode": "string value",
"checklist": {
"optOut": false,
"showCards": {
"inviteTeammate": false,
"visitDemoAccount": false,
"visitMarketplace": false
},
"stepsV1": {
"createdOkr": false,
"invitedTeammate": false,
"visitedDemoAccount": false,
"visitedMarketplace": false,
"watchedVideo": false
},
"stepsV1Completed": false
},
"collapsedEntities": [
"string value 1",
"string value 2"
],
"customFieldsSettings": {
"hideManageOrderBanner": false,
"lastUpdated": "string value"
},
"dashboardSettings": [
{
"dashboardId": "string value",
"settings": "DashboardItemSettings"
}
],
"emailVerified": false,
"favs": [
{
"id": "string value",
"name": "string value",
"type": "string value"
}
],
"goalsGrid": [
{
"field": "string value",
"isCustom": false,
"label": "string value",
"visible": false
}
],
"goalsTreeMode": "string value",
"homeCollapsedItems": {
"myOkrs": false,
"todo": false
},
"homeScreen": "string value",
"insightTemplateSuggestions": {
"dismissed": false,
"insightboards": [
{
"insightboardId": "string value",
"linkToMarketplaceDismissed": false,
"numberOfSuggestionsToShow": 2
}
],
"tooltipShown": false
},
"insightboardParams": {},
"kpiVirtualGroups": {
"favorites": [
"string value 1",
"string value 2"
]
},
"kpis": {
"from": "string value",
"groupBy": "string value",
"to": "string value"
},
"leftNavItems": {
"hub": false,
"insights": false,
"leftNavIsClosed": false,
"lists": false,
"okrs": false,
"people": false,
"reports": false
},
"listFilters": [
"string value 1",
"string value 2"
],
"listIds": [
"string value 1",
"string value 2"
],
"profilesSettings": {
"employeeProfileSettings": {
"processSessionFilter": "ProfilesSessionFilterDto",
"progressSessionFilter": "ProfilesSessionFilterDto"
}
},
"resizableGridColumns": [
{
"goalProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"metricProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"taskProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"width": 2
}
],
"sessionsIds": [
{
"linkedSessionIds": [
"string value 1",
"string value 2"
],
"parentId": "string value"
}
],
"showArchivedSessions": false,
"snippets": [
{
"code": "string value",
"language": "string value",
"name": "string value"
}
],
"surveys": {
"shown": [
"string value 1",
"string value 2"
]
},
"taskOrder": "string value",
"taskView": "string value",
"teamsView": "string value",
"treeViewOrder": {
"field": "string value",
"name": "string value"
},
"useDragMode": false,
"useScrollbars": false,
"verificationEmailSent": false,
"whiteboards": {
"opened": [
{
"id": "string value",
"openedAt": "string value",
"zoom": 2
}
]
}
}
}
],
"name": "string value",
"parentId": "string value",
"picture": "string value",
"richTextDescription": "string value",
"tags": [
{
"createdBy": "string",
"dateCreated": "string value",
"id": "string value",
"isActive": false,
"name": "string value",
"title": "string value"
}
]
}
],
"totalCount": 2
}Gets a team by its unique identifier (id).
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the unique identifier (id) of the Gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| teamId * | string | The unique identifier (id) of the team. expected in path |
| formatting | string | The formatting used for the description and custom fields of type text area.
By default returned as 'mentionsMarkup' (Ex: "@[Mariya Velikova:[email protected]:602a65efc05575000123291b]").
Use 'plainText' if you need the response to be returned without markdown and special markup (Ex: "@Mariya Velikova"). expected in query, sample value: string |
Expected response codes
200 | teamResponse |
401 | unauthorized |
404 | not found |
500 | internal server error |
curl -X GET 'https://app.gtmhub.com/api/v2/integrations/teams/{teamId}?formatting=string' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
var settings = { "url": "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}?formatting=string", "method": "GET", "timeout": 0, "headers": { "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Bearer {token}",
"gtmhub-accountId": "5be26318e5274a0007f17f61",
}
}; $.ajax(settings).done(function (response) { console.log(response); });
NOTE: You must install the module requests.
In a terminal window do: pip install requests
import requests, json
headers = { "Authorization" : "Bearer {token}", "gtmhub-accountId" : "{accountId}", "Content-Type" : "application/json" };
url = "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}"
requests.get(url, headers = headers)
{
"accountId": "string value",
"avatar": "string value",
"badges": [
{
"background": "string value",
"icon": "string value",
"id": "string value",
"name": "string value",
"pattern": "string value",
"summary": "string value"
}
],
"color": "string value",
"dateCreated": "string value",
"description": "string value",
"dynamicValueType": "string value",
"id": "string value",
"isActive": false,
"manager": "string value",
"managerInfo": {
"accountDomain": "string value",
"accountId": "string value",
"accountName": "string value",
"clientId": "string value",
"createdById": "string value",
"dateCreated": "string value",
"dateInvited": "string value",
"email": "string value",
"firstName": "string value",
"id": "string value",
"identities": {
"items": [
{
"clientId": "string value",
"connection": "string value",
"isSocial": false,
"name": "string value",
"provider": "string value"
}
],
"totalCount": 2
},
"invitedBy": "string value",
"isActive": false,
"isPrimary": false,
"isSSOBased": false,
"isSwitched": false,
"language": "string value",
"lastName": "string value",
"name": "string value",
"notificationSettings": {
"subjectsOptedOut": [
"string value 1",
"string value 2"
]
},
"permissions": [
"string value 1",
"string value 2"
],
"picture": "string value",
"pictureInfo": {
"canEditPicture": false,
"isActive": false,
"isPictureEdited": false,
"isSSOBased": false
},
"roles": [
{
"accountId": "string",
"description": "string value",
"id": "string",
"name": "string value",
"team": {
"ExternalTeamMapping": {
"ExternalId": "string value",
"ExternalSystem": "string value"
},
"accountId": "string",
"avatar": "string value",
"color": "string value",
"createdById": "string",
"dateCreated": "string value",
"description": "string value",
"id": "string",
"manager": "string",
"members": [
"ID"
],
"mentions": {},
"modifiedById": "string",
"movedExternalMembers": [
"ID"
],
"name": "string value",
"parentId": "string",
"picture": "string value",
"richTextDescription": "string value",
"tags": [
{
"id": "ID",
"isActive": "IsActiveFlag",
"name": "string value",
"title": "string value"
}
]
}
}
],
"settings": "string value",
"subscriptionType": "string value",
"teamIds": [
"string value 1",
"string value 2"
],
"userSettings": {
"alignmentTreeFilter": {
"ownerIds": "string value",
"tags": "string value",
"teamIds": "string value"
},
"alignmentTreeMode": "string value",
"checklist": {
"optOut": false,
"showCards": {
"inviteTeammate": false,
"visitDemoAccount": false,
"visitMarketplace": false
},
"stepsV1": {
"createdOkr": false,
"invitedTeammate": false,
"visitedDemoAccount": false,
"visitedMarketplace": false,
"watchedVideo": false
},
"stepsV1Completed": false
},
"collapsedEntities": [
"string value 1",
"string value 2"
],
"customFieldsSettings": {
"hideManageOrderBanner": false,
"lastUpdated": "string value"
},
"dashboardSettings": [
{
"dashboardId": "string value",
"settings": [
"DashboardItemSetting"
]
}
],
"emailVerified": false,
"favs": [
{
"id": "string value",
"name": "string value",
"type": "string value"
}
],
"goalsGrid": [
{
"field": "string value",
"isCustom": false,
"label": "string value",
"visible": false
}
],
"goalsTreeMode": "string value",
"homeCollapsedItems": {
"myOkrs": false,
"todo": false
},
"homeScreen": "string value",
"insightTemplateSuggestions": {
"dismissed": false,
"insightboards": [
{
"insightboardId": "string value",
"linkToMarketplaceDismissed": false,
"numberOfSuggestionsToShow": 2
}
],
"tooltipShown": false
},
"insightboardParams": {},
"kpiVirtualGroups": {
"favorites": [
"string value 1",
"string value 2"
]
},
"kpis": {
"from": "string value",
"groupBy": "string value",
"to": "string value"
},
"leftNavItems": {
"hub": false,
"insights": false,
"leftNavIsClosed": false,
"lists": false,
"okrs": false,
"people": false,
"reports": false
},
"listFilters": [
"string value 1",
"string value 2"
],
"listIds": [
"string value 1",
"string value 2"
],
"profilesSettings": {
"employeeProfileSettings": {
"processSessionFilter": {
"sessionIds": [
"string value 1",
"string value 2"
]
},
"progressSessionFilter": {
"sessionIds": [
"string value 1",
"string value 2"
]
}
}
},
"resizableGridColumns": [
{
"goalProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"metricProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"taskProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"width": 2
}
],
"sessionsIds": [
{
"linkedSessionIds": [
"string value 1",
"string value 2"
],
"parentId": "string value"
}
],
"showArchivedSessions": false,
"snippets": [
{
"code": "string value",
"language": "string value",
"name": "string value"
}
],
"surveys": {
"shown": [
"string value 1",
"string value 2"
]
},
"taskOrder": "string value",
"taskView": "string value",
"teamsView": "string value",
"treeViewOrder": {
"field": "string value",
"name": "string value"
},
"useDragMode": false,
"useScrollbars": false,
"verificationEmailSent": false,
"whiteboards": {
"opened": [
{
"id": "string value",
"openedAt": "string value",
"zoom": 2
}
]
}
}
},
"members": [
"string value 1",
"string value 2"
],
"membersInfo": [
{
"accountDomain": "string value",
"accountId": "string value",
"accountName": "string value",
"clientId": "string value",
"createdById": "string value",
"dateCreated": "string value",
"dateInvited": "string value",
"email": "string value",
"firstName": "string value",
"id": "string value",
"identities": {
"items": [
{
"clientId": "string value",
"connection": "string value",
"isSocial": false,
"name": "string value",
"provider": "string value"
}
],
"totalCount": 2
},
"invitedBy": "string value",
"isActive": false,
"isPrimary": false,
"isSSOBased": false,
"isSwitched": false,
"language": "string value",
"lastName": "string value",
"name": "string value",
"notificationSettings": {
"subjectsOptedOut": [
"string value 1",
"string value 2"
]
},
"permissions": [
"string value 1",
"string value 2"
],
"picture": "string value",
"pictureInfo": {
"canEditPicture": false,
"isActive": false,
"isPictureEdited": false,
"isSSOBased": false
},
"roles": [
{
"accountId": "string",
"description": "string value",
"id": "string",
"name": "string value",
"team": {
"ExternalTeamMapping": {
"ExternalId": "string value",
"ExternalSystem": "string value"
},
"accountId": "string",
"avatar": "string value",
"color": "string value",
"createdById": "string",
"dateCreated": "string value",
"description": "string value",
"id": "string",
"manager": "string",
"members": [
"ID"
],
"mentions": {},
"modifiedById": "string",
"movedExternalMembers": [
"ID"
],
"name": "string value",
"parentId": "string",
"picture": "string value",
"richTextDescription": "string value",
"tags": [
{
"id": "ID",
"isActive": "IsActiveFlag",
"name": "string value",
"title": "string value"
}
]
}
}
],
"settings": "string value",
"subscriptionType": "string value",
"teamIds": [
"string value 1",
"string value 2"
],
"userSettings": {
"alignmentTreeFilter": {
"ownerIds": "string value",
"tags": "string value",
"teamIds": "string value"
},
"alignmentTreeMode": "string value",
"checklist": {
"optOut": false,
"showCards": {
"inviteTeammate": false,
"visitDemoAccount": false,
"visitMarketplace": false
},
"stepsV1": {
"createdOkr": false,
"invitedTeammate": false,
"visitedDemoAccount": false,
"visitedMarketplace": false,
"watchedVideo": false
},
"stepsV1Completed": false
},
"collapsedEntities": [
"string value 1",
"string value 2"
],
"customFieldsSettings": {
"hideManageOrderBanner": false,
"lastUpdated": "string value"
},
"dashboardSettings": [
{
"dashboardId": "string value",
"settings": [
"DashboardItemSetting"
]
}
],
"emailVerified": false,
"favs": [
{
"id": "string value",
"name": "string value",
"type": "string value"
}
],
"goalsGrid": [
{
"field": "string value",
"isCustom": false,
"label": "string value",
"visible": false
}
],
"goalsTreeMode": "string value",
"homeCollapsedItems": {
"myOkrs": false,
"todo": false
},
"homeScreen": "string value",
"insightTemplateSuggestions": {
"dismissed": false,
"insightboards": [
{
"insightboardId": "string value",
"linkToMarketplaceDismissed": false,
"numberOfSuggestionsToShow": 2
}
],
"tooltipShown": false
},
"insightboardParams": {},
"kpiVirtualGroups": {
"favorites": [
"string value 1",
"string value 2"
]
},
"kpis": {
"from": "string value",
"groupBy": "string value",
"to": "string value"
},
"leftNavItems": {
"hub": false,
"insights": false,
"leftNavIsClosed": false,
"lists": false,
"okrs": false,
"people": false,
"reports": false
},
"listFilters": [
"string value 1",
"string value 2"
],
"listIds": [
"string value 1",
"string value 2"
],
"profilesSettings": {
"employeeProfileSettings": {
"processSessionFilter": {
"sessionIds": [
"string value 1",
"string value 2"
]
},
"progressSessionFilter": {
"sessionIds": [
"string value 1",
"string value 2"
]
}
}
},
"resizableGridColumns": [
{
"goalProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"metricProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"taskProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"width": 2
}
],
"sessionsIds": [
{
"linkedSessionIds": [
"string value 1",
"string value 2"
],
"parentId": "string value"
}
],
"showArchivedSessions": false,
"snippets": [
{
"code": "string value",
"language": "string value",
"name": "string value"
}
],
"surveys": {
"shown": [
"string value 1",
"string value 2"
]
},
"taskOrder": "string value",
"taskView": "string value",
"teamsView": "string value",
"treeViewOrder": {
"field": "string value",
"name": "string value"
},
"useDragMode": false,
"useScrollbars": false,
"verificationEmailSent": false,
"whiteboards": {
"opened": [
{
"id": "string value",
"openedAt": "string value",
"zoom": 2
}
]
}
}
}
],
"name": "string value",
"parentId": "string value",
"picture": "string value",
"richTextDescription": "string value",
"tags": [
{
"createdBy": "string",
"dateCreated": "string value",
"id": "string value",
"isActive": false,
"name": "string value",
"title": "string value"
}
]
}Creates a new team in the account.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the unique identifier (id) of the Gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| team * | object | The object representing a team. expected in body, sample value: {
"avatar": "users_multiple-11",
"color": "#c9dbd7",
"description": "string value",
"manager": "602b8e27d88095000185f6ff",
"members": [
"602b8e27d88095000185f6ff",
"602b9e27d88095000185f6sf"
],
"name": "Accounting",
"parentId": "602b8e27d88095000185f6ff",
"richTextDescription": "string value"
} |
Expected response codes
201 | teamResponse |
400 | bad request |
401 | unauthorized |
500 | internal server error |
curl -X POST 'https://app.gtmhub.com/api/v2/integrations/teams' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"avatar":"users_multiple-11","color":"#c9dbd7","description":"string value","manager":"602b8e27d88095000185f6ff","members":["602b8e27d88095000185f6ff","602b9e27d88095000185f6sf"],"name":"Accounting","parentId":"602b8e27d88095000185f6ff","richTextDescription":"string value"}'
var body ={ "avatar": "users_multiple-11", "color": "#c9dbd7", "description": "string value", "manager": "602b8e27d88095000185f6ff", "members": [ "602b8e27d88095000185f6ff", "602b9e27d88095000185f6sf" ], "name": "Accounting", "parentId": "602b8e27d88095000185f6ff", "richTextDescription": "string value" };
var settings = { "url": "https://app.gtmhub.com/api/v2/integrations/teams", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Bearer {token}",
"gtmhub-accountId": "5be26318e5274a0007f17f61",
},
"data": body
}; $.ajax(settings).done(function (response) { console.log(response); });
NOTE: You must install the module requests.
In a terminal window do: pip install requests
import requests, json
headers = { "Authorization" : "Bearer {token}", "gtmhub-accountId" : "{accountId}", "Content-Type" : "application/json" };
url = "https://app.gtmhub.com/api/v2/integrations/teams"
body = { "avatar": "users_multiple-11", "color": "#c9dbd7", "description": "string value", "manager": "602b8e27d88095000185f6ff", "members": [ "602b8e27d88095000185f6ff", "602b9e27d88095000185f6sf" ], "name": "Accounting", "parentId": "602b8e27d88095000185f6ff", "richTextDescription": "string value" };
requests.post(url, data=json.dumps(body), headers = headers)
{
"accountId": "string value",
"avatar": "string value",
"badges": [
{
"background": "string value",
"icon": "string value",
"id": "string value",
"name": "string value",
"pattern": "string value",
"summary": "string value"
}
],
"color": "string value",
"dateCreated": "string value",
"description": "string value",
"dynamicValueType": "string value",
"id": "string value",
"isActive": false,
"manager": "string value",
"managerInfo": {
"accountDomain": "string value",
"accountId": "string value",
"accountName": "string value",
"clientId": "string value",
"createdById": "string value",
"dateCreated": "string value",
"dateInvited": "string value",
"email": "string value",
"firstName": "string value",
"id": "string value",
"identities": {
"items": [
{
"clientId": "string value",
"connection": "string value",
"isSocial": false,
"name": "string value",
"provider": "string value"
}
],
"totalCount": 2
},
"invitedBy": "string value",
"isActive": false,
"isPrimary": false,
"isSSOBased": false,
"isSwitched": false,
"language": "string value",
"lastName": "string value",
"name": "string value",
"notificationSettings": {
"subjectsOptedOut": [
"string value 1",
"string value 2"
]
},
"permissions": [
"string value 1",
"string value 2"
],
"picture": "string value",
"pictureInfo": {
"canEditPicture": false,
"isActive": false,
"isPictureEdited": false,
"isSSOBased": false
},
"roles": [
{
"accountId": "string",
"description": "string value",
"id": "string",
"name": "string value",
"team": {
"ExternalTeamMapping": {
"ExternalId": "string value",
"ExternalSystem": "string value"
},
"accountId": "string",
"avatar": "string value",
"color": "string value",
"createdById": "string",
"dateCreated": "string value",
"description": "string value",
"id": "string",
"manager": "string",
"members": [
"ID"
],
"mentions": {},
"modifiedById": "string",
"movedExternalMembers": [
"ID"
],
"name": "string value",
"parentId": "string",
"picture": "string value",
"richTextDescription": "string value",
"tags": [
{
"id": "ID",
"isActive": "IsActiveFlag",
"name": "string value",
"title": "string value"
}
]
}
}
],
"settings": "string value",
"subscriptionType": "string value",
"teamIds": [
"string value 1",
"string value 2"
],
"userSettings": {
"alignmentTreeFilter": {
"ownerIds": "string value",
"tags": "string value",
"teamIds": "string value"
},
"alignmentTreeMode": "string value",
"checklist": {
"optOut": false,
"showCards": {
"inviteTeammate": false,
"visitDemoAccount": false,
"visitMarketplace": false
},
"stepsV1": {
"createdOkr": false,
"invitedTeammate": false,
"visitedDemoAccount": false,
"visitedMarketplace": false,
"watchedVideo": false
},
"stepsV1Completed": false
},
"collapsedEntities": [
"string value 1",
"string value 2"
],
"customFieldsSettings": {
"hideManageOrderBanner": false,
"lastUpdated": "string value"
},
"dashboardSettings": [
{
"dashboardId": "string value",
"settings": [
"DashboardItemSetting"
]
}
],
"emailVerified": false,
"favs": [
{
"id": "string value",
"name": "string value",
"type": "string value"
}
],
"goalsGrid": [
{
"field": "string value",
"isCustom": false,
"label": "string value",
"visible": false
}
],
"goalsTreeMode": "string value",
"homeCollapsedItems": {
"myOkrs": false,
"todo": false
},
"homeScreen": "string value",
"insightTemplateSuggestions": {
"dismissed": false,
"insightboards": [
{
"insightboardId": "string value",
"linkToMarketplaceDismissed": false,
"numberOfSuggestionsToShow": 2
}
],
"tooltipShown": false
},
"insightboardParams": {},
"kpiVirtualGroups": {
"favorites": [
"string value 1",
"string value 2"
]
},
"kpis": {
"from": "string value",
"groupBy": "string value",
"to": "string value"
},
"leftNavItems": {
"hub": false,
"insights": false,
"leftNavIsClosed": false,
"lists": false,
"okrs": false,
"people": false,
"reports": false
},
"listFilters": [
"string value 1",
"string value 2"
],
"listIds": [
"string value 1",
"string value 2"
],
"profilesSettings": {
"employeeProfileSettings": {
"processSessionFilter": {
"sessionIds": [
"string value 1",
"string value 2"
]
},
"progressSessionFilter": {
"sessionIds": [
"string value 1",
"string value 2"
]
}
}
},
"resizableGridColumns": [
{
"goalProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"metricProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"taskProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"width": 2
}
],
"sessionsIds": [
{
"linkedSessionIds": [
"string value 1",
"string value 2"
],
"parentId": "string value"
}
],
"showArchivedSessions": false,
"snippets": [
{
"code": "string value",
"language": "string value",
"name": "string value"
}
],
"surveys": {
"shown": [
"string value 1",
"string value 2"
]
},
"taskOrder": "string value",
"taskView": "string value",
"teamsView": "string value",
"treeViewOrder": {
"field": "string value",
"name": "string value"
},
"useDragMode": false,
"useScrollbars": false,
"verificationEmailSent": false,
"whiteboards": {
"opened": [
{
"id": "string value",
"openedAt": "string value",
"zoom": 2
}
]
}
}
},
"members": [
"string value 1",
"string value 2"
],
"membersInfo": [
{
"accountDomain": "string value",
"accountId": "string value",
"accountName": "string value",
"clientId": "string value",
"createdById": "string value",
"dateCreated": "string value",
"dateInvited": "string value",
"email": "string value",
"firstName": "string value",
"id": "string value",
"identities": {
"items": [
{
"clientId": "string value",
"connection": "string value",
"isSocial": false,
"name": "string value",
"provider": "string value"
}
],
"totalCount": 2
},
"invitedBy": "string value",
"isActive": false,
"isPrimary": false,
"isSSOBased": false,
"isSwitched": false,
"language": "string value",
"lastName": "string value",
"name": "string value",
"notificationSettings": {
"subjectsOptedOut": [
"string value 1",
"string value 2"
]
},
"permissions": [
"string value 1",
"string value 2"
],
"picture": "string value",
"pictureInfo": {
"canEditPicture": false,
"isActive": false,
"isPictureEdited": false,
"isSSOBased": false
},
"roles": [
{
"accountId": "string",
"description": "string value",
"id": "string",
"name": "string value",
"team": {
"ExternalTeamMapping": {
"ExternalId": "string value",
"ExternalSystem": "string value"
},
"accountId": "string",
"avatar": "string value",
"color": "string value",
"createdById": "string",
"dateCreated": "string value",
"description": "string value",
"id": "string",
"manager": "string",
"members": [
"ID"
],
"mentions": {},
"modifiedById": "string",
"movedExternalMembers": [
"ID"
],
"name": "string value",
"parentId": "string",
"picture": "string value",
"richTextDescription": "string value",
"tags": [
{
"id": "ID",
"isActive": "IsActiveFlag",
"name": "string value",
"title": "string value"
}
]
}
}
],
"settings": "string value",
"subscriptionType": "string value",
"teamIds": [
"string value 1",
"string value 2"
],
"userSettings": {
"alignmentTreeFilter": {
"ownerIds": "string value",
"tags": "string value",
"teamIds": "string value"
},
"alignmentTreeMode": "string value",
"checklist": {
"optOut": false,
"showCards": {
"inviteTeammate": false,
"visitDemoAccount": false,
"visitMarketplace": false
},
"stepsV1": {
"createdOkr": false,
"invitedTeammate": false,
"visitedDemoAccount": false,
"visitedMarketplace": false,
"watchedVideo": false
},
"stepsV1Completed": false
},
"collapsedEntities": [
"string value 1",
"string value 2"
],
"customFieldsSettings": {
"hideManageOrderBanner": false,
"lastUpdated": "string value"
},
"dashboardSettings": [
{
"dashboardId": "string value",
"settings": [
"DashboardItemSetting"
]
}
],
"emailVerified": false,
"favs": [
{
"id": "string value",
"name": "string value",
"type": "string value"
}
],
"goalsGrid": [
{
"field": "string value",
"isCustom": false,
"label": "string value",
"visible": false
}
],
"goalsTreeMode": "string value",
"homeCollapsedItems": {
"myOkrs": false,
"todo": false
},
"homeScreen": "string value",
"insightTemplateSuggestions": {
"dismissed": false,
"insightboards": [
{
"insightboardId": "string value",
"linkToMarketplaceDismissed": false,
"numberOfSuggestionsToShow": 2
}
],
"tooltipShown": false
},
"insightboardParams": {},
"kpiVirtualGroups": {
"favorites": [
"string value 1",
"string value 2"
]
},
"kpis": {
"from": "string value",
"groupBy": "string value",
"to": "string value"
},
"leftNavItems": {
"hub": false,
"insights": false,
"leftNavIsClosed": false,
"lists": false,
"okrs": false,
"people": false,
"reports": false
},
"listFilters": [
"string value 1",
"string value 2"
],
"listIds": [
"string value 1",
"string value 2"
],
"profilesSettings": {
"employeeProfileSettings": {
"processSessionFilter": {
"sessionIds": [
"string value 1",
"string value 2"
]
},
"progressSessionFilter": {
"sessionIds": [
"string value 1",
"string value 2"
]
}
}
},
"resizableGridColumns": [
{
"goalProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"metricProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"taskProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"width": 2
}
],
"sessionsIds": [
{
"linkedSessionIds": [
"string value 1",
"string value 2"
],
"parentId": "string value"
}
],
"showArchivedSessions": false,
"snippets": [
{
"code": "string value",
"language": "string value",
"name": "string value"
}
],
"surveys": {
"shown": [
"string value 1",
"string value 2"
]
},
"taskOrder": "string value",
"taskView": "string value",
"teamsView": "string value",
"treeViewOrder": {
"field": "string value",
"name": "string value"
},
"useDragMode": false,
"useScrollbars": false,
"verificationEmailSent": false,
"whiteboards": {
"opened": [
{
"id": "string value",
"openedAt": "string value",
"zoom": 2
}
]
}
}
}
],
"name": "string value",
"parentId": "string value",
"picture": "string value",
"richTextDescription": "string value",
"tags": [
{
"createdBy": "string",
"dateCreated": "string value",
"id": "string value",
"isActive": false,
"name": "string value",
"title": "string value"
}
]
}Activates teams status by ids.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the unique identifier (id) of the Gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| teamsIds * | object | The object representing an array of teams ids to be activated/deactivated. expected in body, sample value: {
"TeamsIds": [
"611fce386400780001b19e1e",
"611fce386400781001b18e2f"
]
} |
Expected response codes
200 | BulkUpdateTeamsActivationStatusResponse |
304 | not modified |
401 | unauthorized |
curl -X POST 'https://app.gtmhub.com/api/v1/teams/activate' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"TeamsIds":["611fce386400780001b19e1e","611fce386400781001b18e2f"]}'
var body ={ "TeamsIds": [ "611fce386400780001b19e1e", "611fce386400781001b18e2f" ] };
var settings = { "url": "https://app.gtmhub.com/api/v1/teams/activate", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Bearer {token}",
"gtmhub-accountId": "5be26318e5274a0007f17f61",
},
"data": body
}; $.ajax(settings).done(function (response) { console.log(response); });
NOTE: You must install the module requests.
In a terminal window do: pip install requests
import requests, json
headers = { "Authorization" : "Bearer {token}", "gtmhub-accountId" : "{accountId}", "Content-Type" : "application/json" };
url = "https://app.gtmhub.com/api/v1/teams/activate"
body = { "TeamsIds": [ "611fce386400780001b19e1e", "611fce386400781001b18e2f" ] };
requests.post(url, data=json.dumps(body), headers = headers)
{
"hasFailures": false,
"items": [
{
"isSuccessful": false,
"teamId": "string value"
}
]
}Deactivates teams status by ids.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the unique identifier (id) of the Gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| teamsIds * | object | The object representing an array of teams ids to be activated/deactivated. expected in body, sample value: {
"TeamsIds": [
"611fce386400780001b19e1e",
"611fce386400781001b18e2f"
]
} |
Expected response codes
200 | BulkUpdateTeamsActivationStatusResponse |
304 | not modified |
401 | unauthorized |
curl -X POST 'https://app.gtmhub.com/api/v1/teams/deactivate' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"TeamsIds":["611fce386400780001b19e1e","611fce386400781001b18e2f"]}'
var body ={ "TeamsIds": [ "611fce386400780001b19e1e", "611fce386400781001b18e2f" ] };
var settings = { "url": "https://app.gtmhub.com/api/v1/teams/deactivate", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Bearer {token}",
"gtmhub-accountId": "5be26318e5274a0007f17f61",
},
"data": body
}; $.ajax(settings).done(function (response) { console.log(response); });
NOTE: You must install the module requests.
In a terminal window do: pip install requests
import requests, json
headers = { "Authorization" : "Bearer {token}", "gtmhub-accountId" : "{accountId}", "Content-Type" : "application/json" };
url = "https://app.gtmhub.com/api/v1/teams/deactivate"
body = { "TeamsIds": [ "611fce386400780001b19e1e", "611fce386400781001b18e2f" ] };
requests.post(url, data=json.dumps(body), headers = headers)
{
"hasFailures": false,
"items": [
{
"isSuccessful": false,
"teamId": "string value"
}
]
}Updates an already existing team in the account.
Note: The avatar and its color should be specified in the request body, otherwise both of them will be reset to the default ones.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the unique identifier (id) of the Gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| teamId * | string | The unique identifier (id) of the team. expected in path |
| team * | object | The object representing a team. expected in body, sample value: {
"avatar": "users_multiple-11",
"color": "#c9dbd7",
"description": "string value",
"manager": "602b8e27d88095000185f6ff",
"members": [
"602b8e27d88095000185f6ff",
"602b9e27d88095000185f6sf"
],
"name": "Accounting",
"parentId": "602b8e27d88095000185f6ff",
"richTextDescription": "string value"
} |
Expected response codes
200 | teamResponse |
400 | bad request |
401 | unauthorized |
404 | not found |
500 | internal server error |
curl -X PUT 'https://app.gtmhub.com/api/v2/integrations/teams/{teamId}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"avatar":"users_multiple-11","color":"#c9dbd7","description":"string value","manager":"602b8e27d88095000185f6ff","members":["602b8e27d88095000185f6ff","602b9e27d88095000185f6sf"],"name":"Accounting","parentId":"602b8e27d88095000185f6ff","richTextDescription":"string value"}'
var body ={ "avatar": "users_multiple-11", "color": "#c9dbd7", "description": "string value", "manager": "602b8e27d88095000185f6ff", "members": [ "602b8e27d88095000185f6ff", "602b9e27d88095000185f6sf" ], "name": "Accounting", "parentId": "602b8e27d88095000185f6ff", "richTextDescription": "string value" };
var settings = { "url": "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}", "method": "PUT", "timeout": 0, "headers": { "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Bearer {token}",
"gtmhub-accountId": "5be26318e5274a0007f17f61",
},
"data": body
}; $.ajax(settings).done(function (response) { console.log(response); });
NOTE: You must install the module requests.
In a terminal window do: pip install requests
import requests, json
headers = { "Authorization" : "Bearer {token}", "gtmhub-accountId" : "{accountId}", "Content-Type" : "application/json" };
url = "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}"
body = { "avatar": "users_multiple-11", "color": "#c9dbd7", "description": "string value", "manager": "602b8e27d88095000185f6ff", "members": [ "602b8e27d88095000185f6ff", "602b9e27d88095000185f6sf" ], "name": "Accounting", "parentId": "602b8e27d88095000185f6ff", "richTextDescription": "string value" };
requests.put(url, data=json.dumps(body), headers = headers)
{
"accountId": "string value",
"avatar": "string value",
"badges": [
{
"background": "string value",
"icon": "string value",
"id": "string value",
"name": "string value",
"pattern": "string value",
"summary": "string value"
}
],
"color": "string value",
"dateCreated": "string value",
"description": "string value",
"dynamicValueType": "string value",
"id": "string value",
"isActive": false,
"manager": "string value",
"managerInfo": {
"accountDomain": "string value",
"accountId": "string value",
"accountName": "string value",
"clientId": "string value",
"createdById": "string value",
"dateCreated": "string value",
"dateInvited": "string value",
"email": "string value",
"firstName": "string value",
"id": "string value",
"identities": {
"items": [
{
"clientId": "string value",
"connection": "string value",
"isSocial": false,
"name": "string value",
"provider": "string value"
}
],
"totalCount": 2
},
"invitedBy": "string value",
"isActive": false,
"isPrimary": false,
"isSSOBased": false,
"isSwitched": false,
"language": "string value",
"lastName": "string value",
"name": "string value",
"notificationSettings": {
"subjectsOptedOut": [
"string value 1",
"string value 2"
]
},
"permissions": [
"string value 1",
"string value 2"
],
"picture": "string value",
"pictureInfo": {
"canEditPicture": false,
"isActive": false,
"isPictureEdited": false,
"isSSOBased": false
},
"roles": [
{
"accountId": "string",
"description": "string value",
"id": "string",
"name": "string value",
"team": {
"ExternalTeamMapping": {
"ExternalId": "string value",
"ExternalSystem": "string value"
},
"accountId": "string",
"avatar": "string value",
"color": "string value",
"createdById": "string",
"dateCreated": "string value",
"description": "string value",
"id": "string",
"manager": "string",
"members": [
"ID"
],
"mentions": {},
"modifiedById": "string",
"movedExternalMembers": [
"ID"
],
"name": "string value",
"parentId": "string",
"picture": "string value",
"richTextDescription": "string value",
"tags": [
{
"id": "ID",
"isActive": "IsActiveFlag",
"name": "string value",
"title": "string value"
}
]
}
}
],
"settings": "string value",
"subscriptionType": "string value",
"teamIds": [
"string value 1",
"string value 2"
],
"userSettings": {
"alignmentTreeFilter": {
"ownerIds": "string value",
"tags": "string value",
"teamIds": "string value"
},
"alignmentTreeMode": "string value",
"checklist": {
"optOut": false,
"showCards": {
"inviteTeammate": false,
"visitDemoAccount": false,
"visitMarketplace": false
},
"stepsV1": {
"createdOkr": false,
"invitedTeammate": false,
"visitedDemoAccount": false,
"visitedMarketplace": false,
"watchedVideo": false
},
"stepsV1Completed": false
},
"collapsedEntities": [
"string value 1",
"string value 2"
],
"customFieldsSettings": {
"hideManageOrderBanner": false,
"lastUpdated": "string value"
},
"dashboardSettings": [
{
"dashboardId": "string value",
"settings": [
"DashboardItemSetting"
]
}
],
"emailVerified": false,
"favs": [
{
"id": "string value",
"name": "string value",
"type": "string value"
}
],
"goalsGrid": [
{
"field": "string value",
"isCustom": false,
"label": "string value",
"visible": false
}
],
"goalsTreeMode": "string value",
"homeCollapsedItems": {
"myOkrs": false,
"todo": false
},
"homeScreen": "string value",
"insightTemplateSuggestions": {
"dismissed": false,
"insightboards": [
{
"insightboardId": "string value",
"linkToMarketplaceDismissed": false,
"numberOfSuggestionsToShow": 2
}
],
"tooltipShown": false
},
"insightboardParams": {},
"kpiVirtualGroups": {
"favorites": [
"string value 1",
"string value 2"
]
},
"kpis": {
"from": "string value",
"groupBy": "string value",
"to": "string value"
},
"leftNavItems": {
"hub": false,
"insights": false,
"leftNavIsClosed": false,
"lists": false,
"okrs": false,
"people": false,
"reports": false
},
"listFilters": [
"string value 1",
"string value 2"
],
"listIds": [
"string value 1",
"string value 2"
],
"profilesSettings": {
"employeeProfileSettings": {
"processSessionFilter": {
"sessionIds": [
"string value 1",
"string value 2"
]
},
"progressSessionFilter": {
"sessionIds": [
"string value 1",
"string value 2"
]
}
}
},
"resizableGridColumns": [
{
"goalProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"metricProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"taskProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"width": 2
}
],
"sessionsIds": [
{
"linkedSessionIds": [
"string value 1",
"string value 2"
],
"parentId": "string value"
}
],
"showArchivedSessions": false,
"snippets": [
{
"code": "string value",
"language": "string value",
"name": "string value"
}
],
"surveys": {
"shown": [
"string value 1",
"string value 2"
]
},
"taskOrder": "string value",
"taskView": "string value",
"teamsView": "string value",
"treeViewOrder": {
"field": "string value",
"name": "string value"
},
"useDragMode": false,
"useScrollbars": false,
"verificationEmailSent": false,
"whiteboards": {
"opened": [
{
"id": "string value",
"openedAt": "string value",
"zoom": 2
}
]
}
}
},
"members": [
"string value 1",
"string value 2"
],
"membersInfo": [
{
"accountDomain": "string value",
"accountId": "string value",
"accountName": "string value",
"clientId": "string value",
"createdById": "string value",
"dateCreated": "string value",
"dateInvited": "string value",
"email": "string value",
"firstName": "string value",
"id": "string value",
"identities": {
"items": [
{
"clientId": "string value",
"connection": "string value",
"isSocial": false,
"name": "string value",
"provider": "string value"
}
],
"totalCount": 2
},
"invitedBy": "string value",
"isActive": false,
"isPrimary": false,
"isSSOBased": false,
"isSwitched": false,
"language": "string value",
"lastName": "string value",
"name": "string value",
"notificationSettings": {
"subjectsOptedOut": [
"string value 1",
"string value 2"
]
},
"permissions": [
"string value 1",
"string value 2"
],
"picture": "string value",
"pictureInfo": {
"canEditPicture": false,
"isActive": false,
"isPictureEdited": false,
"isSSOBased": false
},
"roles": [
{
"accountId": "string",
"description": "string value",
"id": "string",
"name": "string value",
"team": {
"ExternalTeamMapping": {
"ExternalId": "string value",
"ExternalSystem": "string value"
},
"accountId": "string",
"avatar": "string value",
"color": "string value",
"createdById": "string",
"dateCreated": "string value",
"description": "string value",
"id": "string",
"manager": "string",
"members": [
"ID"
],
"mentions": {},
"modifiedById": "string",
"movedExternalMembers": [
"ID"
],
"name": "string value",
"parentId": "string",
"picture": "string value",
"richTextDescription": "string value",
"tags": [
{
"id": "ID",
"isActive": "IsActiveFlag",
"name": "string value",
"title": "string value"
}
]
}
}
],
"settings": "string value",
"subscriptionType": "string value",
"teamIds": [
"string value 1",
"string value 2"
],
"userSettings": {
"alignmentTreeFilter": {
"ownerIds": "string value",
"tags": "string value",
"teamIds": "string value"
},
"alignmentTreeMode": "string value",
"checklist": {
"optOut": false,
"showCards": {
"inviteTeammate": false,
"visitDemoAccount": false,
"visitMarketplace": false
},
"stepsV1": {
"createdOkr": false,
"invitedTeammate": false,
"visitedDemoAccount": false,
"visitedMarketplace": false,
"watchedVideo": false
},
"stepsV1Completed": false
},
"collapsedEntities": [
"string value 1",
"string value 2"
],
"customFieldsSettings": {
"hideManageOrderBanner": false,
"lastUpdated": "string value"
},
"dashboardSettings": [
{
"dashboardId": "string value",
"settings": [
"DashboardItemSetting"
]
}
],
"emailVerified": false,
"favs": [
{
"id": "string value",
"name": "string value",
"type": "string value"
}
],
"goalsGrid": [
{
"field": "string value",
"isCustom": false,
"label": "string value",
"visible": false
}
],
"goalsTreeMode": "string value",
"homeCollapsedItems": {
"myOkrs": false,
"todo": false
},
"homeScreen": "string value",
"insightTemplateSuggestions": {
"dismissed": false,
"insightboards": [
{
"insightboardId": "string value",
"linkToMarketplaceDismissed": false,
"numberOfSuggestionsToShow": 2
}
],
"tooltipShown": false
},
"insightboardParams": {},
"kpiVirtualGroups": {
"favorites": [
"string value 1",
"string value 2"
]
},
"kpis": {
"from": "string value",
"groupBy": "string value",
"to": "string value"
},
"leftNavItems": {
"hub": false,
"insights": false,
"leftNavIsClosed": false,
"lists": false,
"okrs": false,
"people": false,
"reports": false
},
"listFilters": [
"string value 1",
"string value 2"
],
"listIds": [
"string value 1",
"string value 2"
],
"profilesSettings": {
"employeeProfileSettings": {
"processSessionFilter": {
"sessionIds": [
"string value 1",
"string value 2"
]
},
"progressSessionFilter": {
"sessionIds": [
"string value 1",
"string value 2"
]
}
}
},
"resizableGridColumns": [
{
"goalProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"metricProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"taskProperty": {
"propertyName": "string value",
"type": "string value",
"viewName": "string value"
},
"width": 2
}
],
"sessionsIds": [
{
"linkedSessionIds": [
"string value 1",
"string value 2"
],
"parentId": "string value"
}
],
"showArchivedSessions": false,
"snippets": [
{
"code": "string value",
"language": "string value",
"name": "string value"
}
],
"surveys": {
"shown": [
"string value 1",
"string value 2"
]
},
"taskOrder": "string value",
"taskView": "string value",
"teamsView": "string value",
"treeViewOrder": {
"field": "string value",
"name": "string value"
},
"useDragMode": false,
"useScrollbars": false,
"verificationEmailSent": false,
"whiteboards": {
"opened": [
{
"id": "string value",
"openedAt": "string value",
"zoom": 2
}
]
}
}
}
],
"name": "string value",
"parentId": "string value",
"picture": "string value",
"richTextDescription": "string value",
"tags": [
{
"createdBy": "string",
"dateCreated": "string value",
"id": "string value",
"isActive": false,
"name": "string value",
"title": "string value"
}
]
}Assigns a new team manager. The new manager should be an already existing user.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the unique identifier (id) of the Gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| teamId * | string | The unique identifier (id) of the team. expected in path |
| manager * | object | Specifies the unique identifier (id) of the user that will be assigned as a new manager. expected in body, sample value: {
"manager": "string"
} |
Expected response codes
204 | no content |
400 | bad request |
401 | unauthorized |
404 | not found |
500 | internal server error |
curl -X PUT 'https://app.gtmhub.com/api/v2/integrations/teams/{teamId}/manager' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"manager":"string"}'
var body ={ "manager": "string" };
var settings = { "url": "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}/manager", "method": "PUT", "timeout": 0, "headers": { "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Bearer {token}",
"gtmhub-accountId": "5be26318e5274a0007f17f61",
},
"data": body
}; $.ajax(settings).done(function (response) { console.log(response); });
NOTE: You must install the module requests.
In a terminal window do: pip install requests
import requests, json
headers = { "Authorization" : "Bearer {token}", "gtmhub-accountId" : "{accountId}", "Content-Type" : "application/json" };
url = "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}/manager"
body = { "manager": "string" };
requests.put(url, data=json.dumps(body), headers = headers)
Assigns team members to an already existing team.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the unique identifier (id) of the Gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| teamId * | string | The unique identifier (id) of the team. expected in path |
| members * | object | Specifies the unique identifiers (ids) of the users.
If you need to assign more than one user to a team, the ids should be coma separated. expected in body, sample value: {
"members": [
"string",
"string"
]
} |
Expected response codes
204 | no content |
400 | bad request |
401 | unauthorized |
404 | not found |
500 | internal server error |
curl -X PUT 'https://app.gtmhub.com/api/v2/integrations/teams/{teamId}/members' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"members":["string","string"]}'
var body ={ "members": [ "string", "string" ] };
var settings = { "url": "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}/members", "method": "PUT", "timeout": 0, "headers": { "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Bearer {token}",
"gtmhub-accountId": "5be26318e5274a0007f17f61",
},
"data": body
}; $.ajax(settings).done(function (response) { console.log(response); });
NOTE: You must install the module requests.
In a terminal window do: pip install requests
import requests, json
headers = { "Authorization" : "Bearer {token}", "gtmhub-accountId" : "{accountId}", "Content-Type" : "application/json" };
url = "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}/members"
body = { "members": [ "string", "string" ] };
requests.put(url, data=json.dumps(body), headers = headers)
Partially updates a team. Only the fields that are specified in the request body will be updated.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the unique identifier (id) of the Gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| teamId * | string | The unique identifier (id) of the team. expected in path |
| team * | object | Specifies which team properties should be updated and can include individual fields,
a subset of the available fields or all the fields at ones. expected in body, sample value: {
"avatar": "users_multiple-11",
"color": "#c9dbd7",
"customFields": "customFieldMultiselectDropdown: [option1, option2]",
"description": "Some additional info",
"manager": "string",
"members": [
"string"
],
"name": "Accounting",
"parentId": "602b8e27d88095000185f6ff",
"richTextDescription": " |
Expected response codes
200 | |
400 | bad request |
401 | unauthorized |
403 | forbidden |
404 | not found |
500 | internal server error |
curl -X PATCH 'https://app.gtmhub.com/api/v2/integrations/teams/{teamId}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"avatar":"users_multiple-11","color":"#c9dbd7","customFields":"customFieldMultiselectDropdown: [option1, option2]","description":"Some additional info","manager":"string","members":["string"],"name":"Accounting","parentId":"602b8e27d88095000185f6ff","richTextDescription":"Some additional info
"}'
var body ={ "avatar": "users_multiple-11", "color": "#c9dbd7", "customFields": "customFieldMultiselectDropdown: [option1, option2]", "description": "Some additional info", "manager": "string", "members": [ "string" ], "name": "Accounting", "parentId": "602b8e27d88095000185f6ff", "richTextDescription": "Some additional info
" };
var settings = { "url": "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}", "method": "PATCH", "timeout": 0, "headers": { "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Bearer {token}",
"gtmhub-accountId": "5be26318e5274a0007f17f61",
},
"data": body
}; $.ajax(settings).done(function (response) { console.log(response); });
NOTE: You must install the module requests.
In a terminal window do: pip install requests
import requests, json
headers = { "Authorization" : "Bearer {token}", "gtmhub-accountId" : "{accountId}", "Content-Type" : "application/json" };
url = "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}"
body = { "avatar": "users_multiple-11", "color": "#c9dbd7", "customFields": "customFieldMultiselectDropdown: [option1, option2]", "description": "Some additional info", "manager": "string", "members": [ "string" ], "name": "Accounting", "parentId": "602b8e27d88095000185f6ff", "richTextDescription": "Some additional info
" };
requests.patch(url, data=json.dumps(body), headers = headers)
Deletes a team by a specific team unique number identifier (id).
No request object required.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the unique identifier (id) of the Gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| teamId * | string | The unique identifier (id) of the team. expected in path |
Expected response codes
204 | no content |
400 | bad request |
401 | unauthorized |
500 | internal server error |
curl -X DELETE 'https://app.gtmhub.com/api/v2/integrations/teams/{teamId}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
var settings = { "url": "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}", "method": "DELETE", "timeout": 0, "headers": { "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Bearer {token}",
"gtmhub-accountId": "5be26318e5274a0007f17f61",
}
}; $.ajax(settings).done(function (response) { console.log(response); });
NOTE: You must install the module requests.
In a terminal window do: pip install requests
import requests, json
headers = { "Authorization" : "Bearer {token}", "gtmhub-accountId" : "{accountId}", "Content-Type" : "application/json" };
url = "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}"
requests.delete(url, headers = headers)
Removes the team manager.
No request object required.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the unique identifier (id) of the Gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| teamId * | string | The unique identifier (id) of the team. expected in path |
Expected response codes
204 | no content |
400 | bad request |
401 | unauthorized |
404 | not found |
500 | internal server error |
curl -X DELETE 'https://app.gtmhub.com/api/v2/integrations/teams/{teamId}/manager' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
var settings = { "url": "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}/manager", "method": "DELETE", "timeout": 0, "headers": { "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Bearer {token}",
"gtmhub-accountId": "5be26318e5274a0007f17f61",
}
}; $.ajax(settings).done(function (response) { console.log(response); });
NOTE: You must install the module requests.
In a terminal window do: pip install requests
import requests, json
headers = { "Authorization" : "Bearer {token}", "gtmhub-accountId" : "{accountId}", "Content-Type" : "application/json" };
url = "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}/manager"
requests.delete(url, headers = headers)
Deletes a team member.
No request object required.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the unique identifier (id) of the Gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| teamId * | string | The unique identifier (id) of the team. expected in path |
| memberId * | string | Specifies the unique identifier (id) of the team member. expected in path |
Expected response codes
204 | no content |
400 | bad request |
401 | unauthorized |
404 | not found |
500 | internal server error |
curl -X DELETE 'https://app.gtmhub.com/api/v2/integrations/teams/{teamId}/members/{memberId}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
var settings = { "url": "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}/members/{memberId}", "method": "DELETE", "timeout": 0, "headers": { "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Bearer {token}",
"gtmhub-accountId": "5be26318e5274a0007f17f61",
}
}; $.ajax(settings).done(function (response) { console.log(response); });
NOTE: You must install the module requests.
In a terminal window do: pip install requests
import requests, json
headers = { "Authorization" : "Bearer {token}", "gtmhub-accountId" : "{accountId}", "Content-Type" : "application/json" };
url = "https://app.gtmhub.com/api/v2/integrations/teams/{teamId}/members/{memberId}"
requests.delete(url, headers = headers)
Oops! Looks like there are no API calls of that type for this Endpoint
