Badges endpoints
The endpoints in the Badges group enable you to perform CRUD operations with badges, assign and approve them.
Gets all badges based on a filter. If no filter is provided
returns all badges for the account.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the id of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
Expected response codes
200 | badgesResponse |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
500 | internal server error |
curl -X GET 'https://app.quantive.com/results/api/v1/badges' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
var settings = { "url": "https://app.quantive.com/results/api/v1/badges", "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.quantive.com/results/api/v1/badges"
requests.get(url, headers = headers)
{
"items": [
{
"background": "string value",
"icon": "string value",
"id": "string value",
"name": "string value",
"pattern": "string value",
"summary": "string value"
}
],
"totalCount": 2
}Gets all badge assignations that need to be approved.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the id of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
Expected response codes
200 | assignedBadgesResponse |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
500 | internal server error |
curl -X GET 'https://app.quantive.com/results/api/v1/badges/approve' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
var settings = { "url": "https://app.quantive.com/results/api/v1/badges/approve", "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.quantive.com/results/api/v1/badges/approve"
requests.get(url, headers = headers)
{
"items": [
{
"accountId": "string value",
"approvedBy": "string value",
"assignedById": "string value",
"assignedOn": "string value",
"assigneeIds": [
"string value 1",
"string value 2"
],
"badgeId": "string value",
"comment": "string value",
"id": "string value",
"notificationStrategy": "string value",
"notify": [
"string value 1",
"string value 2"
],
"status": "string value"
}
],
"totalCount": 2
}Gets all badges assigned to the current user
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the id of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
Expected response codes
200 | assignedBadgesResponseV2 |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
500 | internal server error |
curl -X GET 'https://app.quantive.com/results/api/v1/badges/assign' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
var settings = { "url": "https://app.quantive.com/results/api/v1/badges/assign", "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.quantive.com/results/api/v1/badges/assign"
requests.get(url, headers = headers)
{
"items": [
{
"accountId": "string value",
"approvedBy": "string value",
"assignedById": "string value",
"assignedOn": "string value",
"assigneeIds": [
"string value 1",
"string value 2"
],
"badge": {
"background": "string value",
"icon": "string value",
"id": "string value",
"name": "string value",
"pattern": "string value",
"summary": "string value"
},
"comment": "string value",
"id": "string value",
"notificationStrategy": "string value",
"notify": [
"string value 1",
"string value 2"
],
"status": "string value"
}
],
"totalCount": 2
}Gets the users/teams that have a specified badge awarded
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the id of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| id * | string | The ID of the badge. expected in path, sample value: 5be26318e5274a0007f17f61 |
Expected response codes
200 | badgeAssigneesResponse |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
404 | not found |
500 | internal server error |
curl -X GET 'https://app.quantive.com/results/api/v1/badges/assign/{id}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
var settings = { "url": "https://app.quantive.com/results/api/v1/badges/assign/{id}", "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.quantive.com/results/api/v1/badges/assign/{id}"
requests.get(url, headers = headers)
{
"Teams": [
{
"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,
"isAzureIDPBased": 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",
"badges": [
"AssignedBadgeExtended"
],
"color": "string value",
"createdById": "ID",
"dateCreated": "string value",
"description": "string value",
"dynamicMetricCount": 2,
"id": "ID",
"manager": "ID",
"manualMetricCount": 2,
"members": "IDs",
"membersGoalCount": 2,
"mentions": "Mentions",
"modifiedById": "ID",
"movedExternalMembers": "IDs",
"name": "string value",
"parentId": "ID",
"picture": "string value",
"tags": [
"TagSimple"
],
"teamGoalCount": 2
}
}
],
"settings": "string value",
"subscriptionType": "string value",
"teamIds": [
"string value 1",
"string value 2"
],
"userSettings": {
"alertSettings": {
"hidePiSettingsAccountAndDomainAlert": false,
"hidePiSettingsMethodologyAlert": false
},
"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"
],
"commentsOrdering": "string value",
"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",
"hasAcceptedPrivacyNotice": false,
"homeCollapsedItems": {
"myOkrs": false,
"todo": false
},
"homeScreen": "string value",
"homeWidgets": {
"closed": [
"string value 1",
"string value 2"
]
},
"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"
],
"myOkrsGrouping": {
"groupBy": "string value",
"sortBy": "string value"
},
"newHomeExperience": false,
"onboardingMetadata": {},
"profilesSettings": {
"employeeProfileSettings": {
"processSessionFilter": "ProfilesSessionFilterDto",
"progressSessionFilter": "ProfilesSessionFilterDto"
}
},
"reflections": {
"newLabel": {
"firstSeenAt": "string value",
"userHasPosted": false
}
},
"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",
"teamsOkrsGrouping": {
"groupBy": "string value",
"sortBy": "string value"
},
"teamsView": "string value",
"theme": "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,
"isAzureIDPBased": 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",
"badges": [
"AssignedBadgeExtended"
],
"color": "string value",
"createdById": "ID",
"dateCreated": "string value",
"description": "string value",
"dynamicMetricCount": 2,
"id": "ID",
"manager": "ID",
"manualMetricCount": 2,
"members": "IDs",
"membersGoalCount": 2,
"mentions": "Mentions",
"modifiedById": "ID",
"movedExternalMembers": "IDs",
"name": "string value",
"parentId": "ID",
"picture": "string value",
"tags": [
"TagSimple"
],
"teamGoalCount": 2
}
}
],
"settings": "string value",
"subscriptionType": "string value",
"teamIds": [
"string value 1",
"string value 2"
],
"userSettings": {
"alertSettings": {
"hidePiSettingsAccountAndDomainAlert": false,
"hidePiSettingsMethodologyAlert": false
},
"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"
],
"commentsOrdering": "string value",
"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",
"hasAcceptedPrivacyNotice": false,
"homeCollapsedItems": {
"myOkrs": false,
"todo": false
},
"homeScreen": "string value",
"homeWidgets": {
"closed": [
"string value 1",
"string value 2"
]
},
"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"
],
"myOkrsGrouping": {
"groupBy": "string value",
"sortBy": "string value"
},
"newHomeExperience": false,
"onboardingMetadata": {},
"profilesSettings": {
"employeeProfileSettings": {
"processSessionFilter": "ProfilesSessionFilterDto",
"progressSessionFilter": "ProfilesSessionFilterDto"
}
},
"reflections": {
"newLabel": {
"firstSeenAt": "string value",
"userHasPosted": false
}
},
"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",
"teamsOkrsGrouping": {
"groupBy": "string value",
"sortBy": "string value"
},
"teamsView": "string value",
"theme": "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",
"tags": [
{
"createdBy": "string",
"dateCreated": "string value",
"id": "string value",
"isActive": false,
"items": [
{
"createdBy": "string",
"dateCreated": "string value",
"id": "string value",
"isActive": false,
"items": [
{
"createdBy": "string",
"dateCreated": "string value",
"id": "string value",
"isActive": false,
"items": [
{
"createdBy": "ID",
"dateCreated": "string value",
"id": "string value",
"isActive": false,
"items": [
"tagResponse"
],
"name": "string value",
"title": "string value"
}
],
"name": "string value",
"title": "string value"
}
],
"name": "string value",
"title": "string value"
}
],
"name": "string value",
"title": "string value"
}
]
}
],
"Users": [
{
"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,
"isAzureIDPBased": 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",
"badges": [
{
"assigneeIds": "IDs",
"badge": "Badge",
"id": "ID"
}
],
"color": "string value",
"createdById": "string",
"dateCreated": "string value",
"description": "string value",
"dynamicMetricCount": 2,
"id": "string",
"manager": "string",
"manualMetricCount": 2,
"members": [
"ID"
],
"membersGoalCount": 2,
"mentions": {},
"modifiedById": "string",
"movedExternalMembers": [
"ID"
],
"name": "string value",
"parentId": "string",
"picture": "string value",
"tags": [
{
"id": "ID",
"isActive": "IsActiveFlag",
"name": "string value",
"title": "string value"
}
],
"teamGoalCount": 2
}
}
],
"settings": "string value",
"subscriptionType": "string value",
"teamIds": [
"string value 1",
"string value 2"
],
"userSettings": {
"alertSettings": {
"hidePiSettingsAccountAndDomainAlert": false,
"hidePiSettingsMethodologyAlert": false
},
"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"
],
"commentsOrdering": "string value",
"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",
"hasAcceptedPrivacyNotice": false,
"homeCollapsedItems": {
"myOkrs": false,
"todo": false
},
"homeScreen": "string value",
"homeWidgets": {
"closed": [
"string value 1",
"string value 2"
]
},
"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"
],
"myOkrsGrouping": {
"groupBy": "string value",
"sortBy": "string value"
},
"newHomeExperience": false,
"onboardingMetadata": {},
"profilesSettings": {
"employeeProfileSettings": {
"processSessionFilter": {
"sessionIds": [
"string value 1",
"string value 2"
]
},
"progressSessionFilter": {
"sessionIds": [
"string value 1",
"string value 2"
]
}
}
},
"reflections": {
"newLabel": {
"firstSeenAt": "string value",
"userHasPosted": false
}
},
"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",
"teamsOkrsGrouping": {
"groupBy": "string value",
"sortBy": "string value"
},
"teamsView": "string value",
"theme": "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
}
]
}
}
}
]
}Gets all badges assigned to the current user
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the id of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
Expected response codes
200 | assignedBadgesResponseV2 |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
500 | internal server error |
curl -X GET 'https://app.quantive.com/results/api/v1/badges/current' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
var settings = { "url": "https://app.quantive.com/results/api/v1/badges/current", "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.quantive.com/results/api/v1/badges/current"
requests.get(url, headers = headers)
{
"items": [
{
"accountId": "string value",
"approvedBy": "string value",
"assignedById": "string value",
"assignedOn": "string value",
"assigneeIds": [
"string value 1",
"string value 2"
],
"badge": {
"background": "string value",
"icon": "string value",
"id": "string value",
"name": "string value",
"pattern": "string value",
"summary": "string value"
},
"comment": "string value",
"id": "string value",
"notificationStrategy": "string value",
"notify": [
"string value 1",
"string value 2"
],
"status": "string value"
}
],
"totalCount": 2
}Gets a single badge based on the provided id.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the id of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| id * | string | The ID of the badge. expected in path, sample value: 5be26318e5274a0007f17f61 |
Expected response codes
200 | badgeResponse |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
404 | not found |
500 | internal server error |
curl -X GET 'https://app.quantive.com/results/api/v1/badges/{id}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
var settings = { "url": "https://app.quantive.com/results/api/v1/badges/{id}", "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.quantive.com/results/api/v1/badges/{id}"
requests.get(url, headers = headers)
{
"background": "string value",
"icon": "string value",
"id": "string value",
"name": "string value",
"pattern": "string value",
"summary": "string value"
}Creates a badge in the current gtmhub account
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the id of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| badge * | object | expected in body, sample value: {
"assignCondition": "string value",
"background": "string value",
"icon": "string value",
"name": "string value",
"pattern": "string value",
"summary": "string value",
"type": "string value"
} |
Expected response codes
201 | badgeResponse |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
500 | internal server error |
curl -X POST 'https://app.quantive.com/results/api/v1/badges' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"assignCondition":"string value","background":"string value","icon":"string value","name":"string value","pattern":"string value","summary":"string value","type":"string value"}'
var body ={ "assignCondition": "string value", "background": "string value", "icon": "string value", "name": "string value", "pattern": "string value", "summary": "string value", "type": "string value" };
var settings = { "url": "https://app.quantive.com/results/api/v1/badges", "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.quantive.com/results/api/v1/badges"
body = { "assignCondition": "string value", "background": "string value", "icon": "string value", "name": "string value", "pattern": "string value", "summary": "string value", "type": "string value" };
requests.post(url, data=json.dumps(body), headers = headers)
{
"background": "string value",
"icon": "string value",
"id": "string value",
"name": "string value",
"pattern": "string value",
"summary": "string value"
}Approves a request to assign a badge
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the id of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| id * | string | The ID of the assigned badge request. expected in path, sample value: 5be26318e5274a0007f17f61 |
Expected response codes
204 | no content |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
500 | internal server error |
curl -X POST 'https://app.quantive.com/results/api/v1/badges/approve/{id}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
var settings = { "url": "https://app.quantive.com/results/api/v1/badges/approve/{id}", "method": "POST", "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.quantive.com/results/api/v1/badges/approve/{id}"
requests.post(url, headers = headers)
Assign a badge to an assignee. The assignee can either be a user or a team.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the id of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| assignBadge * | object | expected in body, sample value: {
"assignedById": "string value",
"assigneeIds": [
"string value 1",
"string value 2"
],
"badgeId": "string value",
"comment": "string value",
"notificationStrategy": "string value",
"notify": [
"string value 1",
"string value 2"
]
} |
Expected response codes
200 | assignedBadgeResponse |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
500 | internal server error |
curl -X POST 'https://app.quantive.com/results/api/v1/badges/assign' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"assignedById":"string value","assigneeIds":["string value 1","string value 2"],"badgeId":"string value","comment":"string value","notificationStrategy":"string value","notify":["string value 1","string value 2"]}'
var body ={ "assignedById": "string value", "assigneeIds": [ "string value 1", "string value 2" ], "badgeId": "string value", "comment": "string value", "notificationStrategy": "string value", "notify": [ "string value 1", "string value 2" ] };
var settings = { "url": "https://app.quantive.com/results/api/v1/badges/assign", "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.quantive.com/results/api/v1/badges/assign"
body = { "assignedById": "string value", "assigneeIds": [ "string value 1", "string value 2" ], "badgeId": "string value", "comment": "string value", "notificationStrategy": "string value", "notify": [ "string value 1", "string value 2" ] };
requests.post(url, data=json.dumps(body), headers = headers)
{
"accountId": "string value",
"approvedBy": "string value",
"assignedById": "string value",
"assignedOn": "string value",
"assigneeIds": [
"string value 1",
"string value 2"
],
"badgeId": "string value",
"comment": "string value",
"id": "string value",
"notificationStrategy": "string value",
"notify": [
"string value 1",
"string value 2"
],
"status": "string value"
}Updates a badge properties.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the id of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| id * | string | The ID of the badge. expected in path, sample value: 5be26318e5274a0007f17f61 |
| badge * | object | expected in body, sample value: {
"assignCondition": "string value",
"background": "string value",
"icon": "string value",
"name": "string value",
"pattern": "string value",
"summary": "string value",
"type": "string value"
} |
Expected response codes
204 | no content |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
404 | not found |
500 | internal server error |
curl -X PATCH 'https://app.quantive.com/results/api/v1/badges/{id}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"assignCondition":"string value","background":"string value","icon":"string value","name":"string value","pattern":"string value","summary":"string value","type":"string value"}'
var body ={ "assignCondition": "string value", "background": "string value", "icon": "string value", "name": "string value", "pattern": "string value", "summary": "string value", "type": "string value" };
var settings = { "url": "https://app.quantive.com/results/api/v1/badges/{id}", "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.quantive.com/results/api/v1/badges/{id}"
body = { "assignCondition": "string value", "background": "string value", "icon": "string value", "name": "string value", "pattern": "string value", "summary": "string value", "type": "string value" };
requests.patch(url, data=json.dumps(body), headers = headers)
Rejects a request to assign a badge
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the id of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| id * | string | The ID of the assigned badge request. expected in path, sample value: 5be26318e5274a0007f17f61 |
Expected response codes
204 | no content |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
500 | internal server error |
curl -X DELETE 'https://app.quantive.com/results/api/v1/badges/approve/{id}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
var settings = { "url": "https://app.quantive.com/results/api/v1/badges/approve/{id}", "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.quantive.com/results/api/v1/badges/approve/{id}"
requests.delete(url, headers = headers)
Unassigns a given badge from an assignee. The assignee can either be a team or a user.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the id of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| badgeAssignId * | string | Specifies the badge assign id. expected in path |
| assigneeId * | string | The ID of the assignee. Can be either team or user id. expected in path |
Expected response codes
204 | no content |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
500 | internal server error |
curl -X DELETE 'https://app.quantive.com/results/api/v1/badges/assign/{assigneeId}/{badgeAssignId}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
var settings = { "url": "https://app.quantive.com/results/api/v1/badges/assign/{assigneeId}/{badgeAssignId}", "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.quantive.com/results/api/v1/badges/assign/{assigneeId}/{badgeAssignId}"
requests.delete(url, headers = headers)
Deletes a badge with a given ID.
Parameters
| Name | Type | Description |
|---|---|---|
| gtmhub-accountId * | string | Specifies the id of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
| id * | string | The ID of the badge. expected in path, sample value: 5be26318e5274a0007f17f61 |
Expected response codes
204 | no content |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
500 | internal server error |
curl -X DELETE 'https://app.quantive.com/results/api/v1/badges/{id}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
var settings = { "url": "https://app.quantive.com/results/api/v1/badges/{id}", "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.quantive.com/results/api/v1/badges/{id}"
requests.delete(url, headers = headers)
Oops! Looks like there are no API calls of that type for this Endpoint
