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

 

Get /teams/{team_id}

Get a specific Team by its ID

Returns the unique team matching the {team_id}

Request URL

https://{client_id}.salesseek.net/api/teams/d26691fd026

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: "d26691fd026"
  name: "Everyone"
}

 

Parameters

ParameterRequiredDescriptionParameter TypeData Type
team_idY

String to use for getting a team

could be an id or a short_id

string

 


 

 

PATCH /teams/{team_id}

Updates a specific Team by its ID

Update a Team by {team_id} and Returns the resulting team

 

Request URL

https://{client_id}.salesseek.net/api/teams/d26691f5-e1de

Request Body
{
  name: "Everyone_changed"
}

 

Response Type

Response content type: JSON Team

ModelExample of Response

Team {

id (string): unique identifier for the Team,

name (string): name to be shown

}

{
  id: "d26691f5-e1de"
  name: "Everyone_changed"
}

 

Parameters

ParameterRequiredDescriptionParameter TypeData Type
team_idY

String to use for getting a team

could be an id or a short_id

string
teamYA subset of model fields for updatingJSON

 


 

 

Get /teams

Provides the entire list of Teams

Returns a list of teams

Request URL

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

Response Type

Response content type: JSON array[Team/User]

ModelExample of Response

array[Team/User]

 

Team {

id (string): unique identifier for the Team,

short_id (string): alias which also identifies the Team,

title (string): name to be shown,

title_highlight (string): html when highlighting,

type (string): "salesseek.core.models.teams.Team"

}

User

[
  {
    id: "d2665a5d026"
    short_id: "everyone"
    title: "Everyone"
    title_highlight: "<em></em>Everyone"
    type: "salesseek.core.models.teams.Team" 
  },
  {
    id: "a89d84a4cfa7c2ef"
    short_id: "a89d8499-9861-492f-a513-5da4cfa7c2ef"
    title: "John Edwards"
    title_highlight: "<em></em>John Edwards"
    type: "salesseek.core.models.user.User"
  }
]

 

Parameters

ParameterRequiredDescriptionParameter TypeData Type
? sort?    

 


 

 

Get /teams?search

Provides the result list of teams after search

Returns the result of searching on the teams by the value of the search parameter

Request URL

https://{client_id}.salesseek.net/api/teams?search=a&_=1408592672256

Response Type

Response content type: JSON array[Team/User]

ModelExample of Response

array[Team/User]

 

Team {

id (string): unique identifier for the Team,

short_id (string): alias which also identifies the Team,

title (string): name to be shown,

title_highlight (string): html when highlighting,

type (string): "salesseek.core.models.teams.Team"

}

User

[
  {
    id: "a89d82ef"
    short_id: "a89cfa7c2ef"
    title: "John Edwards"
    title_highlight: "<em></em>John Edwards"
    type: "salesseek.core.models.user.User"
  }
]

 

Parameters

ParameterRequiredDescriptionParameter TypeData Type
searchYString to use for searching teams / usersstring

  • No labels