Page tree
Skip to end of metadata
Go to start of metadata

Get /team_hierarchy

Provides the entire list of Team Hierarchy 

Returns the entire list of  Team Hierarchy .

SalesSeek System Users are organized in different levels of hierarchy, this list the entire list of hierarchies

Request URL

https://{client_id}.salesseek.net/api/team_hierarchy  

Response Type

Response content type: JSON Array[User_Team_Hierarchy]

ModelExample of Response

Array[User_Team_Hierarchy]

Hierarchy User (JSON) {

id (string): unique identifier for the User,

name (string): name to be shown,

quota (Array[Quota]): array of the configured Sales Target for this User,

preferences (JSON): {

default_dashboard (Enum: team, sales, sales manager, marketing, ceo): the role of this user: default is team

}

children(Array[Users]): unique id of your SalesSeek system,

team (Team): basic info from SalesSeek system

}

User {

id (string): unique identifier for the User,

name (string): name to be shown,

type (string): "user"

email_address (string): unique email address identifying this user,

quota (Array[Quota]): array of the configured Sales Target for this User,

preferences (JSON): {

default_dashboard (Enum: team, sales, sales manager, marketing, ceo): the role of this user: default is team

}

}

Quota {

value (number): target value for the sales person to reach in this specific revenue bucket,

bucket_id (string): the unique id for this this revenue bucket

}

Team {

id (string): unique identifier for the Team,

name (string): name of the Team to be shown

}

[
	0:{
		quota: [
    		{"value": 100.0, "bucket_id": "99db6"},
    		{"value": 200.0, "bucket_id": "8bc83"},
    		{"value": 300.0, "bucket_id": "7aa26"}
  		], 
  		preferences: {"default_dashboard": "team"}, 
		name: "Kate Wilson", 
  		id: "5f8c9",
  		team: {
			id: "975c8afa3a",
			name: "Kate Wilson's team"
		}
		children: [
			0:{
				id: "7c83f91"
				name: "Nadia Jones"
				preferences: {default_dashboard:team}
				quota: : [
    				0: {"value": 50.0, "bucket_id": "99db6"},
		    		1: {"value": 100.0, "bucket_id": "8bc83"},
    				2: {"value": 100.0, "bucket_id": "7aa26"}
  				], 
			},
			1: {...}
		]
	}
},
  1:{....}
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
responseOut-Resulting list of Users per Team HierarchyArray[User_Team_Hierarchy]

 


 

 

PATCH /team_hierarchy

Updates the team hierarchy

Updates the team hierarchy by changing parent to one user, if the new parent didn have a team before then a new Team is automatically created and will be the response to this request.

 

Request URL

https://{client_id}.salesseek.net/api/team_hierarchy  

 

Request Body
{
	/*this parameter should be omitted in case this user is changed to the Team on top of the Hierarchy*/
  	new_parent_user_id: "ae93579e4", 
	user_id: "7c83fc83e61"
}

 

Response Type

Response content type: JSON Team

ModelExample of Response

Team {

id (string): unique identifier for the Team,

name (string): name of the Team to be shown

}

{
    id: "80f2453fa"
    name: "Alex's team"
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
new_parent_user_idInYThe id of the user who is going to be the new parent of the selected userstring
 user_idInYThe id of the user which is changing parent on this hierarchystring
 response OutOnly the team that has been updatedJSON
  • No labels