Teams endpoints

The Teams group contains endpoints that enable you to create, retrieve, update and delete Teams in your Gtmhub account.

🔗
get
/teams
Gets all the teams in the account
Parameters
NameTypeDescription
fieldsstringList of fields to be retrieved, separated by comas (,).
expected in query, sample value:
name,description
sortstringList of fields separated by comas (,). To invert a field's sort, you can prefix its name with a minus (-). For example, the following expression: sort=-name,dateCreated would return entities in reverse lexicographical order and then ordered by dateCreated.
expected in query, sample value:
-name,dateCreated
filterstringThe format of the parameter is inspired by the MongoDB query format. For example, the following expression {name: {$in: ["sales", "marketing"]}} would return all the entities that have name either "sales" or "marketing". This expression {"name":{$regex:".*Sales.*"}} would return entities that contain "Sales" in their names.
expected in query, sample value:
{name: {$in: ["sales", "marketing"]}}
skipintegerHow many entities to be skipped when executing a GET query. By default skip value is 0.
expected in query, sample value:
5
limitintegerThe max number of entities that can be returned by the GET query. By default take value is 100.
expected in query, sample value:
10
formattingstringThe 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

curl -X GET 'https://app.gtmhub.com/api/v2/teams?fields=name,description&sort=-name,dateCreated&filter={name: {$in: ["sales", "marketing"]}}&skip=5&limit=10&formatting=plainText' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \

var settings = { "url": "https://app.gtmhub.com/api/v2/teams?fields=name,description&sort=-name,dateCreated&filter={name: {$in: ["sales", "marketing"]}}&skip=5&limit=10&formatting=plainText", "method": "GET", "timeout": 0, "headers": { "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Bearer {token}",
}
}; $.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/teams"



requests.get(url, headers = headers)
🔗
get
/teams/{teamId}
Gets a team by its unique identifier (id).
Parameters
NameTypeDescription
gtmhub-accountId
*
stringSpecifies the unique identifier (id) of the Gtmhub account.
expected in header, sample value:
5be26318e5274a0007f17f61
teamId
*
stringThe unique identifier (id) of the team.
expected in path
formattingstringThe 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
200teamResponse
401unauthorized

curl -X GET 'https://app.gtmhub.com/api/v1/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/v1/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/v1/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",
    "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"
            ],
            "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"
                ],
                "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"
        }
    ]
}
🔗
post
/teams
Creates a new team in the account.
Parameters
NameTypeDescription
gtmhub-accountId
*
stringSpecifies the unique identifier (id) of the Gtmhub account.
expected in header, sample value:
5be26318e5274a0007f17f61
team
*
objectThe 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
201teamResponse
401unauthorized

curl -X POST 'https://app.gtmhub.com/api/v1/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/v1/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/v1/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",
    "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"
            ],
            "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"
                ],
                "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"
        }
    ]
}
🔗
put
/teams/{teamId}
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
NameTypeDescription
gtmhub-accountId
*
stringSpecifies the unique identifier (id) of the Gtmhub account.
expected in header, sample value:
5be26318e5274a0007f17f61
teamId
*
stringThe unique identifier (id) of the team.
expected in path
team
*
objectThe 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
200teamResponse
401unauthorized

curl -X PUT 'https://app.gtmhub.com/api/v1/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/v1/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/v1/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",
    "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"
            ],
            "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"
                ],
                "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"
        }
    ]
}
🔗
put
/teams/{teamId}/manager
Assigns a new team manager. The new manager should be an already existing user.
Parameters
NameTypeDescription
gtmhub-accountId
*
stringSpecifies the unique identifier (id) of the Gtmhub account.
expected in header, sample value:
5be26318e5274a0007f17f61
teamId
*
stringThe unique identifier (id) of the team.
expected in path
manager
*
objectSpecifies 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
204no content
401unauthorized

curl -X PUT 'https://app.gtmhub.com/api/v1/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/v1/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/v1/teams/{teamId}/manager"

body = { "manager": "string" };

requests.put(url, data=json.dumps(body), headers = headers)
🔗
put
/teams/{teamId}/members
Assigns team members to an already existing team.
Parameters
NameTypeDescription
gtmhub-accountId
*
stringSpecifies the unique identifier (id) of the Gtmhub account.
expected in header, sample value:
5be26318e5274a0007f17f61
teamId
*
stringThe unique identifier (id) of the team.
expected in path
members
*
objectSpecifies 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"
    ]
}
Expected response codes
204no content
401unauthorized

curl -X PUT 'https://app.gtmhub.com/api/v1/teams/{teamId}/members' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"members":["string"]}'

var body ={ "members": [ "string" ] };

var settings = { "url": "https://app.gtmhub.com/api/v1/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/v1/teams/{teamId}/members"

body = { "members": [ "string" ] };

requests.put(url, data=json.dumps(body), headers = headers)
🔗
patch
/teams/{teamId}
Partially updates a team. Only the fields that are specified in the request body will be updated.
Parameters
NameTypeDescription
gtmhub-accountId
*
stringSpecifies the unique identifier (id) of the Gtmhub account.
expected in header, sample value:
5be26318e5274a0007f17f61
teamId
*
stringThe unique identifier (id) of the team.
expected in path
team
*
objectSpecifies 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": "

Some additional info

" }
Expected response codes
200
401unauthorized

curl -X PATCH 'https://app.gtmhub.com/api/v1/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/v1/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/v1/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)
🔗
delete
/teams/{teamId}
Deletes a team by a specific team unique number identifier (id).
No request object required.
Parameters
NameTypeDescription
gtmhub-accountId
*
stringSpecifies the unique identifier (id) of the Gtmhub account.
expected in header, sample value:
5be26318e5274a0007f17f61
teamId
*
stringThe unique identifier (id) of the team.
expected in path
Expected response codes
204no content
401unauthorized

curl -X DELETE 'https://app.gtmhub.com/api/v1/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/v1/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/v1/teams/{teamId}"



requests.delete(url, headers = headers)
🔗
delete
/teams/{teamId}/manager
Removes the team manager.
No request object required.
Parameters
NameTypeDescription
gtmhub-accountId
*
stringSpecifies the unique identifier (id) of the Gtmhub account.
expected in header, sample value:
5be26318e5274a0007f17f61
teamId
*
stringThe unique identifier (id) of the team.
expected in path
Expected response codes
204no content
401unauthorized

curl -X DELETE 'https://app.gtmhub.com/api/v1/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/v1/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/v1/teams/{teamId}/manager"



requests.delete(url, headers = headers)
🔗
delete
/teams/{teamId}/members/{memberId}
Deletes a team member.
No request object required.
Parameters
NameTypeDescription
gtmhub-accountId
*
stringSpecifies the unique identifier (id) of the Gtmhub account.
expected in header, sample value:
5be26318e5274a0007f17f61
teamId
*
stringThe unique identifier (id) of the team.
expected in path
memberId
*
stringSpecifies the unique identifier (id) of the team member.
expected in path
Expected response codes
204no content
401unauthorized

curl -X DELETE 'https://app.gtmhub.com/api/v1/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/v1/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/v1/teams/{teamId}/members/{memberId}"



requests.delete(url, headers = headers)