Users

Users endpoints

The Users endpoints enable you to create, retrieve, update and delete users in your Quantive Results account.

get

/users

Loads all users for a specific account using filter, sort and field projection.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the unique identifier (id) of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
fields *	string	Specifies the list of fields to be returned in the response. For example, to get only the user's email, first and last name use fields=email,firstName,lastName expected in path, sample value: `email,firstName,lastName`
limit	integer	The max number of entities that can be returned by the GET query. By default take value is 100. expected in query, sample value: `10`
formatting	string	The formatting used for the description and custom fields of type text area. By default returned as 'mentionsMarkup'. Ex: "@[John Smith:john.smith@okrs.tech: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`
filter	string	Specifies the filter in Mongo syntax. For example, to get a single user by their Id, use filter={"_id":"611fce386400780001b19e1e"}. expected in query, sample value: `{"_id":"611fce386400780001b19e1e"}`
sort	string	Specifies the sort expression. For example, to sort users by their creation date user sort=dateCreated or sort=-dateCreated (to sort in descending order). expected in query, sample value: `dateCreated`
skip	string	Specifies how many items to skip from the beginning of the collection. Use this to implement paging. For example, if you want to get users 5-10 use skip=5&take=5. Always sort your response to ensure that you're paging through the collection in the same order, for example sort=dateCreated&skip=5&take=5. expected in query, sample value: `5`
take	string	Specifies how many items to take from the collection. Use this to implement paging. For example, if you want to get the first 10 users use take=10. Always sort your response to ensure that you're paging through the collection in the same order, for example sort=dateCreated&take=10. expected in query, sample value: `10`

Expected response codes

`200`	`usersResponse`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`500`	`internal server error`


 curl -X GET 'https://app.quantive.com/results/api/v2/users?limit=10&formatting=plainText&filter={"_id":"611fce386400780001b19e1e"}&sort=dateCreated&skip=5&take=10' \
   -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/v2/users?limit=10&formatting=plainText&filter={"_id":"611fce386400780001b19e1e"}&sort=dateCreated&skip=5&take=10",
 "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/v2/users"



requests.get(url, headers = headers)

{
    "accessToken": "string value",
    "accountDomain": "string value",
    "edition": "string value",
    "idToken": "string value",
    "planId": "string value",
    "userId": "string value"
}

🔗

get

/users/{userId}

Gets a single user by provided user ID.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the unique identifier (id) of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
userId *	string	Specifies the user unique identifier (id). expected in path
formatting	string	The formatting used for the custom fields of type text area. By default they are returned as 'mentionsMarkup' and they can contain markdown and special markup for mentioned people. Use 'plainText' if you want the response without markdown and special markup. expected in query, sample value: `string`

Expected response codes

`200`	`userResponse`
`400`	`bad request`
`403`	`forbidden`
`404`	`not found`
`500`	`internal server error`


 curl -X GET 'https://app.quantive.com/results/api/v1/users/{userId}?formatting=string' \
   -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/users/{userId}?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.quantive.com/results/api/v1/users/{userId}"



requests.get(url, headers = headers)

{
    "accountDomain": "string value",
    "accountId": "string value",
    "accountName": "string value",
    "clientId": "string value",
    "createdById": "string value",
    "dateCreated": "string value",
    "dateDeactivated": "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": [
                            "ID"
                        ],
                        "badge": {
                            "accountId": "ID",
                            "assignmentCondition": "string value",
                            "background": "string value",
                            "icon": "string value",
                            "id": "ID",
                            "name": "string value",
                            "pattern": "string value",
                            "summary": "string value",
                            "type": "string value"
                        },
                        "id": "string"
                    }
                ],
                "color": "string value",
                "createdById": "string",
                "dateCreated": "string value",
                "description": "string value",
                "dynamicMetricCount": 2,
                "id": "string",
                "isActive": {
                    "DateDeactivated": "string value",
                    "IsActive": false
                },
                "manager": "string",
                "manualMetricCount": 2,
                "members": [
                    "string"
                ],
                "membersGoalCount": 2,
                "mentions": {},
                "modifiedById": "string",
                "movedExternalMembers": [
                    "string"
                ],
                "name": "string value",
                "parentId": "string",
                "picture": "string value",
                "tags": [
                    {
                        "id": "string",
                        "isActive": {
                            "DateDeactivated": "string value",
                            "IsActive": false
                        },
                        "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": [
                    {
                        "dynamicValues": [
                            "DashboardDynamicValue"
                        ],
                        "name": "string value",
                        "value": "string value",
                        "valueDisplayName": "string value",
                        "valueDisplayNameAsArray": [
                            "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",
        "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": {},
        "organizationChartSettings": {
            "showDeactivatedMembers": false,
            "showDeactivatedTeams": false
        },
        "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,
        "showDeactivatedTeams": false,
        "showDeactivatedUsers": 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
                }
            ]
        }
    }
}

🔗

get

/users/{userId}/managers

Gets all manager id's for teams that user belongs to where the user is not the manager of the team.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the unique identifier (id) of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
userId *	string	Specifies the user unique identifier (id). expected in path

Expected response codes

`200`	`userManagersResponse`
`400`	`bad request`
`404`	`not found`
`500`	`internal server error`


 curl -X GET 'https://app.quantive.com/results/api/v1/users/{userId}/managers' \
   -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/users/{userId}/managers",
 "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/users/{userId}/managers"



requests.get(url, headers = headers)

{
    "count": 2,
    "managers": [
        "6137904697f8520001e18ff3",
        "607db83f2a004000014k16a4"
    ]
}

🔗

post

/users

Creates multiple or a single user. You must have the correct permissions to create multiple or a single user.

Parameters

Name	Type	Description

Expected response codes

`201`	`usersResponse`
`400`	`bad request`
`401`	`unauthorized`
`403`	`forbidden`
`409`	`conflict`
`500`	`internal server error`


 curl -X POST 'https://app.quantive.com/results/api/v1/users' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/users",
 "method": "POST",
 "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.quantive.com/results/api/v1/users"



requests.post(url, headers = headers)

{
    "accessToken": "string value",
    "accountDomain": "string value",
    "edition": "string value",
    "idToken": "string value",
    "planId": "string value",
    "userId": "string value"
}

🔗

post

/users/activate

Bulk activate of the provided users.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the unique identifier (id) of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
gtmhub-additional-params	string	Internal use only. Specifies additional parameters in the request header. expected in header
usersIds *		An array of selected users to invited in batch. expected in body, sample value: `["6154ad124654jdk901e43c15", "6166f85e4a38b89301380b13"]`

Expected response codes

`200`	`BulkUpdateUsersActivationStatusResponse`
`400`	`bad request`
`403`	`forbidden`
`500`	`internal server error`


 curl -X POST 'https://app.quantive.com/results/api/v1/users/activate' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
   -H 'gtmhub-additional-params: ' \
   -d '["6154ad124654jdk901e43c15", "6166f85e4a38b89301380b13"]'


var body ='["6154ad124654jdk901e43c15", "6166f85e4a38b89301380b13"]'

var settings = {
 "url": "https://app.quantive.com/results/api/v1/users/activate",
 "method": "POST",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
   "gtmhub-additional-params": "",
 },
 "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/users/activate"

body =  ["6154ad124654jdk901e43c15", "6166f85e4a38b89301380b13"];

requests.post(url, data=json.dumps(body), headers = headers)

{
    "hasFailures": false,
    "items": [
        {
            "isSuccessful": false,
            "userId": "string value"
        }
    ]
}

🔗

post

/users/deactivate

Bulk deactivate of the provided users.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the unique identifier (id) of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
gtmhub-additional-params	string	Internal use only. Specifies additional parameters in the request header. expected in header
usersIds *		An array of selected users to invited in batch. expected in body, sample value: `["6154ad124654jdk901e43c15", "6166f85e4a38b89301380b13"]`

Expected response codes

`200`	`BulkUpdateUsersActivationStatusResponse`
`400`	`bad request`
`403`	`forbidden`
`500`	`internal server error`


 curl -X POST 'https://app.quantive.com/results/api/v1/users/deactivate' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
   -H 'gtmhub-additional-params: ' \
   -d '["6154ad124654jdk901e43c15", "6166f85e4a38b89301380b13"]'


var body ='["6154ad124654jdk901e43c15", "6166f85e4a38b89301380b13"]'

var settings = {
 "url": "https://app.quantive.com/results/api/v1/users/deactivate",
 "method": "POST",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
   "gtmhub-additional-params": "",
 },
 "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/users/deactivate"

body =  ["6154ad124654jdk901e43c15", "6166f85e4a38b89301380b13"];

requests.post(url, data=json.dumps(body), headers = headers)

{
    "hasFailures": false,
    "items": [
        {
            "isSuccessful": false,
            "userId": "string value"
        }
    ]
}

🔗

post

/users/delete

Bulk delete of the provided users.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the unique identifier (id) of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
gtmhub-additional-params	string	Internal use only. Specifies additional parameters in the request header. expected in header
userIDs *		An array of selected users to be deleted in batch. expected in body, sample value: `["6169fc51cfe8soer8548f4b0f", "6169fc53cfe80388888f4b1d"]`

Expected response codes

`200`	`usersBulkDeleteResponse`
`400`	`bad request`
`403`	`forbidden`
`404`	`not found`
`500`	`internal server error`


 curl -X POST 'https://app.quantive.com/results/api/v1/users/delete' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
   -H 'gtmhub-additional-params: ' \
   -d '["6169fc51cfe8soer8548f4b0f", "6169fc53cfe80388888f4b1d"]'


var body ='["6169fc51cfe8soer8548f4b0f", "6169fc53cfe80388888f4b1d"]'

var settings = {
 "url": "https://app.quantive.com/results/api/v1/users/delete",
 "method": "POST",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
   "gtmhub-additional-params": "",
 },
 "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/users/delete"

body =  ["6169fc51cfe8soer8548f4b0f", "6169fc53cfe80388888f4b1d"];

requests.post(url, data=json.dumps(body), headers = headers)

{
    "hasFailures": false,
    "items": [
        {
            "isSuccessful": false,
            "userId": "string value"
        }
    ]
}

🔗

post

/users/invitations

Sends invitation emails to selected users.

Helpful if you invited users to your account and chose to not send invitation emails.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the unique identifier (id) of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
usersIds *		An array of selected users to invited in batch. expected in body, sample value: `["6154ad124654jdk901e43c15", "6166f85e4a38b89301380b13"]`

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/users/invitations' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
   -d '["6154ad124654jdk901e43c15", "6166f85e4a38b89301380b13"]'


var body ='["6154ad124654jdk901e43c15", "6166f85e4a38b89301380b13"]'

var settings = {
 "url": "https://app.quantive.com/results/api/v1/users/invitations",
 "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/users/invitations"

body =  ["6154ad124654jdk901e43c15", "6166f85e4a38b89301380b13"];

requests.post(url, data=json.dumps(body), headers = headers)

🔗

post

/users/roles

Bulk update to change roles for current users.

Supports multiple roles and multiples users to be updated simultaneously.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the unique identifier (id) of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
bulkUpdateUserRoles *	object	The object representing a bulk request to update user roles. expected in body, sample value: { "roleIds": [ "573d93d9ed915d00052e321d, 5d970316e65bc40001a51df2" ], "userIds": [ "607db83f2a004000014aax45", "60abdcc666fde50001321s23s" ] }

Expected response codes

`200`	`bulkUpdateUsersRolesResponse`
`400`	`bad request`
`403`	`forbidden`
`500`	`internal server error`


 curl -X POST 'https://app.quantive.com/results/api/v1/users/roles' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
   -d '{"roleIds":["573d93d9ed915d00052e321d, 5d970316e65bc40001a51df2"],"userIds":["607db83f2a004000014aax45","60abdcc666fde50001321s23s"]}'


var body ={
    "roleIds": [
        "573d93d9ed915d00052e321d, 5d970316e65bc40001a51df2"
    ],
    "userIds": [
        "607db83f2a004000014aax45",
        "60abdcc666fde50001321s23s"
    ]
};

var settings = {
 "url": "https://app.quantive.com/results/api/v1/users/roles",
 "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/users/roles"

body =  {
    "roleIds": [
        "573d93d9ed915d00052e321d, 5d970316e65bc40001a51df2"
    ],
    "userIds": [
        "607db83f2a004000014aax45",
        "60abdcc666fde50001321s23s"
    ]
};

requests.post(url, data=json.dumps(body), headers = headers)

{
    "hasFailures": false,
    "items": [
        {
            "failedAddings": [
                {
                    "reason": "string value",
                    "roleId": "string value"
                }
            ],
            "failedRemoves": [
                {
                    "reason": "string value",
                    "roleId": "string value"
                }
            ],
            "userId": "string value"
        }
    ],
    "updatedUsersCount": 2
}

🔗

post

/users/{userId}/roles

Assigns a single role to a user.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the unique identifier (id) of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
gtmhub-additional-params	string	Internal use only. Specifies additional parameters in the request header. expected in header
userId *	string	Specifies the user unique identifier (id). expected in path
userRoleRequest *	object	Relation between a user and a role. expected in body, sample value: { "roleId": "5d970316e65bc40001a51d13" }

Expected response codes

`200`	`ok`
`400`	`bad request`
`404`	`not found`


 curl -X POST 'https://app.quantive.com/results/api/v1/users/{userId}/roles' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
   -H 'gtmhub-additional-params: ' \
   -d '{"roleId":"5d970316e65bc40001a51d13"}'


var body ={
    "roleId": "5d970316e65bc40001a51d13"
};

var settings = {
 "url": "https://app.quantive.com/results/api/v1/users/{userId}/roles",
 "method": "POST",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
   "gtmhub-additional-params": "",
 },
 "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/users/{userId}/roles"

body =  {
    "roleId": "5d970316e65bc40001a51d13"
};

requests.post(url, data=json.dumps(body), headers = headers)

🔗

post

/users/{userId}/send-change-password-email

This handler is used to prepare to send the reset password link.

Parameters

Name	Type	Description

Expected response codes

`200`	`ok`
`400`	`bad request`
`401`	`unauthorized`
`403`	`forbidden`
`500`	`internal server error`


 curl -X POST 'https://app.quantive.com/results/api/v1/users/{userId}/send-change-password-email' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/users/{userId}/send-change-password-email",
 "method": "POST",
 "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.quantive.com/results/api/v1/users/{userId}/send-change-password-email"



requests.post(url, headers = headers)

DEPRECATED

🔗

put

/users/settings

Updates the user's personal settings.

This endpoint is deprecated. Use PUT Users instead.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the unique identifier (id) of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
gtmhub-additional-params	string	Internal use only. Specifies additional parameters in the request header. expected in header

Expected response codes

`200`	`ok`
`400`	`bad request`
`404`	`not found`
`500`	`internal server error`


 curl -X PUT 'https://app.quantive.com/results/api/v1/users/settings' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
   -H 'gtmhub-additional-params: ' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/users/settings",
 "method": "PUT",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
   "gtmhub-additional-params": "",
 }
};
$.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/users/settings"



requests.put(url, headers = headers)

🔗

put

/users/{userId}

Updates the user's personal language settings.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the unique identifier (id) of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
gtmhub-additional-params	string	Internal use only. Specifies additional parameters in the request header. expected in header
userId *	string	Specifies the user unique identifier (id). expected in path
userSettingsRequest *	object	expected in body, sample value: { "language": "english", "notificationSettings": { "subjectsOptedOut": [ "string value 1", "string value 2" ] } }

Expected response codes

`200`	`ok`
`400`	`bad request`
`500`	`internal server error`


 curl -X PUT 'https://app.quantive.com/results/api/v1/users/{userId}' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
   -H 'gtmhub-additional-params: ' \
   -d '{"language":"english","notificationSettings":{"subjectsOptedOut":["string value 1","string value 2"]}}'


var body ={
    "language": "english",
    "notificationSettings": {
        "subjectsOptedOut": [
            "string value 1",
            "string value 2"
        ]
    }
};

var settings = {
 "url": "https://app.quantive.com/results/api/v1/users/{userId}",
 "method": "PUT",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
   "gtmhub-additional-params": "",
 },
 "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/users/{userId}"

body =  {
    "language": "english",
    "notificationSettings": {
        "subjectsOptedOut": [
            "string value 1",
            "string value 2"
        ]
    }
};

requests.put(url, data=json.dumps(body), headers = headers)

🔗

patch

/users/{userId}

Updates the users first and last name.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the unique identifier (id) of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
userId *	string	Specifies the user unique identifier (id). expected in path
userInfo *	object	The user information you'd like to update expected in body, sample value: { "firstName": "string value", "lastName": "string value" }

Expected response codes

`200`	`ok`
`400`	`bad request`
`403`	`forbidden`
`404`	`not found`
`500`	`internal server error`


 curl -X PATCH 'https://app.quantive.com/results/api/v1/users/{userId}' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
   -d '{"firstName":"string value","lastName":"string value"}'


var body ={
    "firstName": "string value",
    "lastName": "string value"
};

var settings = {
 "url": "https://app.quantive.com/results/api/v1/users/{userId}",
 "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/users/{userId}"

body =  {
    "firstName": "string value",
    "lastName": "string value"
};

requests.patch(url, data=json.dumps(body), headers = headers)

🔗

patch

/users/{userId}/info

Updates the users first and last name.

Parameters

Name	Type	Description
userId *	string	Specifies the user unique identifier (id). expected in path

Expected response codes

`200`	`ok`
`400`	`bad request`
`403`	`forbidden`
`404`	`not found`
`500`	`internal server error`


 curl -X PATCH 'https://app.quantive.com/results/api/v1/users/{userId}/info' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/users/{userId}/info",
 "method": "PATCH",
 "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.quantive.com/results/api/v1/users/{userId}/info"



requests.patch(url, headers = headers)

🔗

delete

/accounts/user/{id}

Deletes a user with the specified id.

This operation deletes the user from the database irreversibly.

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 user. expected in path, sample value: `5be26318e5274a0007f17f61`

Expected response codes

`200`	`ok`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`409`	`conflict`
`500`	`internal server error`


 curl -X DELETE 'https://app.quantive.com/results/api/v1/accounts/user/{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/accounts/user/{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/accounts/user/{id}"



requests.delete(url, headers = headers)

🔗

delete

/users/{userId}/roles/{roleId}

Deletes selected role from selected user.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the unique identifier (id) of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
userId *	string	Specifies the user unique identifier (id). expected in path
roleId *	string	Specifies the unique role identifier (roleId). expected in path

Expected response codes

`200`	`ok`
`400`	`bad request`
`404`	`not found`
`409`	`conflict`
`500`	`internal server error`


 curl -X DELETE 'https://app.quantive.com/results/api/v1/users/{userId}/roles/{roleId}' \
   -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/users/{userId}/roles/{roleId}",
 "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/users/{userId}/roles/{roleId}"



requests.delete(url, headers = headers)

🔗

delete

/users/{userId}/roles?ids={roleIds}

Deletes selected roles from selected user.

Parameters

Name	Type	Description

Expected response codes

`200`	`ok`
`400`	`bad request`
`409`	`conflict`
`500`	`internal server error`


 curl -X DELETE 'https://app.quantive.com/results/api/v1/users/{userId}/roles?ids={roleIds}' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/users/{userId}/roles?ids={roleIds}",
 "method": "DELETE",
 "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.quantive.com/results/api/v1/users/{userId}/roles?ids={roleIds}"



requests.delete(url, headers = headers)

Oops! Looks like there are no API calls of that type for this Endpoint