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

 

Get /users

Provides a list of SalesSeek users

Returns a list of SalesSeek users

Request URL

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

Response Type

Response content type: JSON array[Users]

ModelExample of Response

array[Users]

User {

id (string): unique identifier for the User,

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

is_admin (boolean): true or false if he this user has admin permissions,

name (string): name to be shown,

preferences (array[JSON]): including the type of user,

type (string): "salesseek.core.models.user.User"

}

[
  {
    email_address: "michael@gmail.com"
    id: "2901ef8a38"
    is_admin: true
    name: "Michael Black"
    preferences: {default_dashboard:team}
    type: "users"
  }
, 
  {
    email_address: "karl@salesseek.net"
    id: "ae9f528866"
    is_admin: false
    name: "Karl West"
    preferences: {default_dashboard:CEO}
    type: "users"
  }
]

 

Parameters

 

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Records-TotalOut-

Total amount of records (even if are not in this search)

int
Records-StartOut-The index of the first row on the responseint
Records-RowsOut-How many rows were returnedint

 

 


 

Get /users?search=<value>

Provides a list of SalesSeek users searching by name

Returns a list of SalesSeek users based on a search criteria: name

Request URL

https://{client_id}.salesseek.net/api/users?search=mic

Response Type

Response content type: JSON array[Users]

ModelExample of Response

array[Users]

User {

id (string): unique identifier for the User,

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

is_admin (boolean): true or false if he this user has admin permissions,

name (string): name to be shown,

preferences (array[JSON]): including the type of user,

type (string): "salesseek.core.models.user.User"

}

[
  {
    email_address: "michael@gmail.com"
    id: "2901ef8a38"
    is_admin: true
    name: "Michael Black"
    preferences: {default_dashboard:team}
    type: "users"
  }
, 
  {
    email_address: "collin@salesseek.net"
    id: "ae9f528866"
    is_admin: false
    name: "Collin Mick"
    preferences: {default_dashboard:CEO}
    type: "users"
  }
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Records-TotalOut-

Total amount of records (even if are not in this search)

int
Records-StartOut-The index of the first row on the responseint
Records-RowsOut-How many rows were returnedint
searchInYIts value will be the search by name criteriastring

 


 

POST /user

Creates a new SalesSeek user

Creates a new User and Returns the resulting User

 

Request URL

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

Request Body
{
  email_address: "wilson@gmail.com"
  name: "Kate Wilson"
  password: "" /* password should always be empty "" */
}

 

Response Type

Response content type: JSON Team

ModelExample of Response

 

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,

short_id (string): Alias which can be used as a unique identifier for the User,

is_admin (boolean): by default it is created as non administrator,

favourites_id (string): the unique id for this user set of favourites contacts,

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

}

client_id(string): unique id of your SalesSeek system,

client (Client): basic info from SalesSeek system,

ical_url (string): the url to use on ical for this user to sync,

password_reset_required (boolean): next time this user logs in the system will require him to change his pass, by default: true

}

Client (JSON) {

client_id (String): unique string to identify this client,

currencies (Currencies): pairs of names and values of accepted currencies, configured on the as additional from the default one,

default_currency (Enum): unique 3-char id for the default currency (the rest of the currencies will have an associated conversion rate against the default currency), see the table of currencies,

facebook_page_id (String): Unique ID for the real facebook page configured as a Social Lead Source. null if it haven't been configured.

id (String): unique string to identify this client,

marketing_groups (Groups_list): list of groups which the logged user in the current SalesSeek system has configured to be shown as his own set of groups in the Marketing dashboard

name (String) : Name of the SalesSeek System Client,

 short_id (String): alternative id or alias to reference to this client

type (string): its always clients

}

Groups_list (JSON) {

groups (Array[String]): list of groups ids which the logged user in the current SalesSeek system has configured to be shown as his own set of groups in the Marketing dashboard

}


Currencies (AssociativeCollection)

{

/* List of Pairs of <Key> and <Value>, relates a currency Key with an exchange rate to be converted to the default currency*/

<Value>(number): vale of the conversion rate from this currency to the default currency, ie: if the default currency is USD, GBP can be added with an aprox value of 0.62,

<Key>(string): 3 chars id for the currency, check the following table for all available currencies:

 

 Click here for all available currencies...

Key

Currency Name

AUD

Australian Dollar
BRLBrasilian Real
CADCanadian Dollar
CHFSwiss Franc
CLPChilean Peso
CNY

Chinese Yuan

CZKCzech Koruna
DKKDanish Krone
EUREuro
FJDFiji Dollar
GBPBritish Pound
HKDHong Kong Dollar
HNLHonduran Lempira
HUFHungarian Forint
IDRIndonesian Rupiah
ILSIsraeli New Shekel
INRIndonesian Rupee
ISKIceland Krona
JPYJapansese Yen
KRWKorean Won
MXNMexican Peso
MYRMalasyan Ringgit
NOKNorwegian Krone
NZDNew Zealand Dollar
PHPPhilippine Peso
PKRPakistan Rupee
PLNPolish Zloty
RUBRussian Ruble
SEKSwedish Krona
SGDSingapore Dollar
THBThai Baht
TRYTurkish Lira
TWDTaiwan Dollar
ZARSouth Africa Rand

}


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

}

 

{
  short_id: "c89970", 
  is_admin: false, 
  favorites_id: "43404", 
  type: "users", 
  quota: [
	{"value": 10.0, "bucket_id": "991cdb6"}, 
	{"value": 20.0, "bucket_id": "8bc7f383"}, 
	{"value": 30.0, "bucket_id": "7aa206286"}
  ],, 
  preferences: {"default_dashboard": "team"}, 
  client_id: "669908d6f", 
  name: "Kate Wilson", 
  client: {
    short_id: "aptui", 
    client_id: "669908d6f", 
    name: "Demo Client for APTUI", 
    currencies: {
      AUD: 2, 
      BRL: 3
    }, 
    marketing_groups": {
      groups: [
        "5262b998a6",
        "fc899a0c6c"
      ]
    }
    facebook_page_id: 998877665544, 
    default_currency: "USD", 
    type: "clients", 
    id: "669908d6f"
  }, 
  id: "5f8c9", 
  email_address: "wilson@gmail.com", 
  ical_url: "/users/5f048c9/icalendar_feed?token=a7b6e", 
  password_reset_required: true
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
userOut-The user created after the successful request

 

JSON

 

 


 

Get /users/{user_id}

Get a specific User by its ID

Returns the unique user matching the {user_id}

Request URL

https://{client_id}.salesseek.net/api/users/d26691f5-e1de-4c6c-bbd3-640585a5d026

Response Type

Response content type: JSON User

ModelExample of Response

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,

short_id (string): Alias which can be used as a unique identifier for the User,

is_admin (boolean): by default it is created as non administrator,

favourites_id (string): the unique id for this user set of favourites contacts,

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

}

client_id(string): unique id of your SalesSeek system,

client (Client): basic info from SalesSeek system,

ical_url (string): the url to use on ical for this user to sync,

password_reset_required (boolean): next time this user logs in the system will require him to change his pass, by default: true

}

Client (JSON) {

client_id (String): unique string to identify this client,

currencies (Currencies): pairs of names and values of accepted currencies, configured on the as additional from the default one,

default_currency (Enum): unique 3-char id for the default currency (the rest of the currencies will have an associated conversion rate against the default currency), see the table of currencies,

facebook_page_id (String): Unique ID for the real facebook page configured as a Social Lead Source. null if it haven't been configured.

id (String): unique string to identify this client,

marketing_groups (Groups_list): list of groups which the logged user in the current SalesSeek system has configured to be shown as his own set of groups in the Marketing dashboard

name (String) : Name of the SalesSeek System Client,

 short_id (String): alternative id or alias to reference to this client

type (string): its always clients

}

Groups_list (JSON) {

groups (Array[String]): list of groups ids which the logged user in the current SalesSeek system has configured to be shown as his own set of groups in the Marketing dashboard

}


Currencies (AssociativeCollection)

{

/* List of Pairs of <Key> and <Value>, relates a currency Key with an exchange rate to be converted to the default currency*/

<Value>(number): vale of the conversion rate from this currency to the default currency, ie: if the default currency is USD, GBP can be added with an aprox value of 0.62,

<Key>(string): 3 chars id for the currency, check the following table for all available currencies:

 

 Click here for all available currencies...

Key

Currency Name

AUD

Australian Dollar
BRLBrasilian Real
CADCanadian Dollar
CHFSwiss Franc
CLPChilean Peso
CNY

Chinese Yuan

CZKCzech Koruna
DKKDanish Krone
EUREuro
FJDFiji Dollar
GBPBritish Pound
HKDHong Kong Dollar
HNLHonduran Lempira
HUFHungarian Forint
IDRIndonesian Rupiah
ILSIsraeli New Shekel
INRIndonesian Rupee
ISKIceland Krona
JPYJapansese Yen
KRWKorean Won
MXNMexican Peso
MYRMalasyan Ringgit
NOKNorwegian Krone
NZDNew Zealand Dollar
PHPPhilippine Peso
PKRPakistan Rupee
PLNPolish Zloty
RUBRussian Ruble
SEKSwedish Krona
SGDSingapore Dollar
THBThai Baht
TRYTurkish Lira
TWDTaiwan Dollar
ZARSouth Africa Rand

}


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

}

 

{
  short_id: "c89970", 
  is_admin: false, 
  favorites_id: "43404", 
  type: "users", 
  quota: [
	{"value": 10.0, "bucket_id": "991cdb6"}, 
	{"value": 20.0, "bucket_id": "8bc7f383"}, 
	{"value": 30.0, "bucket_id": "7aa206286"}
  ],, 
  preferences: {"default_dashboard": "team"}, 
  client_id: "669908d6f", 
  name: "Kate Wilson", 
  client: {
    short_id: "aptui", 
    client_id: "669908d6f", 
    name: "Demo Client for APTUI", 
    currencies: {
      AUD: 2, 
      BRL: 3
    }, 
    marketing_groups": {
      groups: [
        "5262b998a6",
        "fc899a0c6c"
      ]
    }
    facebook_page_id: 998877665544, 
    default_currency: "USD", 
    type: "clients", 
    id: "669908d6f"
  }, 
  id: "5f8c9", 
  email_address: "wilson@gmail.com", 
  ical_url: "/users/5f048c9/icalendar_feed?token=a7b6e", 
  password_reset_required: true
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
userOut-The user created after the successful request

 

JSON
user_idInYThe user created after the successful request

 

string

 


 

 

PATCH /users/{user_id}

Update a specific User by its ID

Update a User by {user_id} and Returns the resulting User. The fields updated are just the ones passed on the request body

Request URL

https://{client_id}.salesseek.net/api/users/a3451f5-e1de-4c6c-bbd3-640585a5d026

Request Body
{
  email_address: "changed_email@gmail.com"
}

 

Response Type

Response content type: JSON User

ModelExample of Response

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,

short_id (string): Alias which can be used as a unique identifier for the User,

is_admin (boolean): by default it is created as non administrator,

favourites_id (string): the unique id for this user set of favourites contacts,

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

}

client_id(string): unique id of your SalesSeek system,

client (Client): basic info from SalesSeek system,

ical_url (string): the url to use on ical for this user to sync,

password_reset_required (boolean): next time this user logs in the system will require him to change his pass, by default: true

}

Client (JSON) {

client_id (String): unique string to identify this client,

currencies (Currencies): pairs of names and values of accepted currencies, configured on the as additional from the default one,

default_currency (Enum): unique 3-char id for the default currency (the rest of the currencies will have an associated conversion rate against the default currency), see the table of currencies,

facebook_page_id (String): Unique ID for the real facebook page configured as a Social Lead Source. null if it haven't been configured.

id (String): unique string to identify this client,

marketing_groups (Groups_list): list of groups which the logged user in the current SalesSeek system has configured to be shown as his own set of groups in the Marketing dashboard

name (String) : Name of the SalesSeek System Client,

 short_id (String): alternative id or alias to reference to this client

type (string): its always clients

}

Groups_list (JSON) {

groups (Array[String]): list of groups ids which the logged user in the current SalesSeek system has configured to be shown as his own set of groups in the Marketing dashboard

}


Currencies (AssociativeCollection)

{

/* List of Pairs of <Key> and <Value>, relates a currency Key with an exchange rate to be converted to the default currency*/

<Value>(number): vale of the conversion rate from this currency to the default currency, ie: if the default currency is USD, GBP can be added with an aprox value of 0.62,

<Key>(string): 3 chars id for the currency, check the following table for all available currencies:

 

 Click here for all available currencies...

Key

Currency Name

AUD

Australian Dollar
BRLBrasilian Real
CADCanadian Dollar
CHFSwiss Franc
CLPChilean Peso
CNY

Chinese Yuan

CZKCzech Koruna
DKKDanish Krone
EUREuro
FJDFiji Dollar
GBPBritish Pound
HKDHong Kong Dollar
HNLHonduran Lempira
HUFHungarian Forint
IDRIndonesian Rupiah
ILSIsraeli New Shekel
INRIndonesian Rupee
ISKIceland Krona
JPYJapansese Yen
KRWKorean Won
MXNMexican Peso
MYRMalasyan Ringgit
NOKNorwegian Krone
NZDNew Zealand Dollar
PHPPhilippine Peso
PKRPakistan Rupee
PLNPolish Zloty
RUBRussian Ruble
SEKSwedish Krona
SGDSingapore Dollar
THBThai Baht
TRYTurkish Lira
TWDTaiwan Dollar
ZARSouth Africa Rand

}


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

}

 

{
  short_id: "c89970", 
  is_admin: false, 
  favorites_id: "43404", 
  type: "users", 
  quota: [
	{"value": 10.0, "bucket_id": "991cdb6"}, 
	{"value": 20.0, "bucket_id": "8bc7f383"}, 
	{"value": 30.0, "bucket_id": "7aa206286"}
  ],, 
  preferences: {"default_dashboard": "team"}, 
  client_id: "669908d6f", 
  name: "Kate Wilson", 
  client: {
    short_id: "aptui", 
    client_id: "669908d6f", 
    name: "Demo Client for APTUI", 
    currencies: {
      AUD: 2, 
      BRL: 3
    }, 
    marketing_groups": {
      groups: [
        "5262b998a6",
        "fc899a0c6c"
      ]
    }
    facebook_page_id: 998877665544, 
    default_currency: "USD", 
    type: "clients", 
    id: "669908d6f"
  }, 
  id: "5f8c9", 
  email_address: "wilson@gmail.com", 
  ical_url: "/users/5f048c9/icalendar_feed?token=a7b6e", 
  password_reset_required: true
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
user_idInYThe id of the user to be updatedstring
userInYThe subset of the user model fields to be updatedJSON
userOutThe user after the successful update

 

JSON

 

 


 

DELETE /users/{user_id}

Deletes a specific User by its ID

Delete a User by {user_id}

Request URL

https://{client_id}.salesseek.net/api/users/a3451f5-e1de-4c6c-bbd3-640585a5d026  

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
user_idInYThe id of user to be deletedstring

 


 

Get /users/{user_id}/favorite_opportunities

Provides the list of Favorite Opportunities associated to this User 

Provides the list of Favorite_opportunities associated to this User 

Request URL

https://{client_id}.salesseek.net/api/users/69d1f4ae62/favorite_opportunities?start=0&rows=10

Response Type

Response content type: JSON Array[Opportunities]

ModelExample of Response
Array[opportunities]


Opportunity (JSON) {

currency(Enum): 3 letters abbreviation for the currency affecting all revenue buckets of this deal,

expected_close_date(timestamp): estimated close date for this deal, formatted as YYYY-MM-ddThh_mm_ss.msecs,

id (string): unique identifier for this opportunity,

name(string): Deal's name to be shown,

phase(Phase): details about the specific Funnel Phase this deal is,

buckets(Array[Buckets]): List of revenue bucket for this current deal,

custom_fields (Associative Array): Associative array organised in pairs of id: value,

default_value(number): ?????,

latest_activity_in_days(int): Amount of days since the last activity over this deal,

organization(Organization): A deal is always related to an organization (required),

organization_id: unique identifier for the organization the deal is associated,

owner(Owner): each deal has a SalesSeek user who owns it (is responsible of),

owner_id(string): unique identifier for the SalesSeek user who owns this deal,

permissions: [???],

phase_id(string): id of the Funnel Phase this deal is,

phase_last_changed(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

phase_name(string): name of the Funnel Phase this deal is,

phase_number(int): position number of the Funnel Phase this deal is,

short_id(string): Alias which can be used as a unique identifier for the Bucket,

type(string): "opportunities",

value(number): total deal's size: sum of all bucket values,

comments(string): additional generic information not included on other fields (or custom fields),

is_favorite(boolean): true or false if this deal is favorite for the current SalesSeek user

}

 

Buckets(JSON): {

id (string): unique identifier for this bucket,

name (int): bucket name to be shown,

value (number): value for the current bucket inside this deal (depends on the currency),

default_value (string): ???

}

Organization(JSON): {

id (string): unique identifier for this organization,

name (int): organization name to be shown

}

Owner(JSON): {

id (string): unique identifier for the SalesSeek user who owns this deal,

name (int): name of the SalesSeek user who owns this deal

}

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

}

[
  {
    abbreviation: "F25"
    buckets: [
      0:{
        name:New Structure, 
        value:75000, 
        default_value:75000, 
        id:7d2e38b6d
      },
      1:{…}
    ]
    currency: "USD"
    custom_fields: {
      128d597afb923a:"https://www.google.com/NewStructure"
    }
    default_value: 75000
    expected_close_date: "2014-01-29T23:00:00"
    id: "184ffbf0aad9"
    latest_activity_in_days: 3
    name: "Refurbishing Opera House"
    organization: {
      id: "8d6455f0c6"
      name: "Opera House"
    }
    organization_id: "8d6455f0c6"
    owner: {
      id: "2901f25"
      name: "Anna Karina"
    }
    owner_id: "2901f25"
    permissions: [
      0: "salesseek.core.view",
      1: "salesseek.core.all_permissions",
      2: "salesseek.core.edit"
    ]
    phase: {
      id: "5b540b026a8"
      name: "Scheduled Visit"
      order: 2
    }
    phase_id: "5b540b026a8"
    phase_last_changed: "2014-01-18T12:26:30.055763"
    phase_name: "Scheduled visit"
    phase_number: 2
    short_id: "5b540b028"
    type: "opportunities"
    value: 75000
  },
  1:{...
  }
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Records-RowsOut-

Amount of records returned in this search

int
Records-StartOut-The index of the first row on the response (in case there are more results, paginated)int
Records-TotalOut-Total amount of records (even if are not in this search result)int
rowsInNThe maximum amount of element to be requestedint
startInNThe element number to start to retrieve the data (0 for the first position)int
responseOut-Resulting list of Favorite OpportunitiesArray[Opportunities]

 


 

POST /users/{user_id}/favorite_opportunities

Creates a new Favorite_opportunity associated to {user_id}

Adds the selected opportunity as a new Favorite_opportunity associated to User by its {user_id}

Request URL

https://{client_id}.salesseek.net/api/users/888899/favorite_opportunities

Request Body
{
	id: "56634246262"
}

 

Response Type

Response content type: null


Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Favorite_opportunity_idInYThe id of Favorite_opportunity to be addedJSON

 


 

DELETE /users/{user_id}/favorite_opportunities/{favorite_opportunity_id}

Deletes a specific Favorite_opportunity by its ID

Delete a specific Favorite_opportunity which is associated to the User {favorite_opportunity_id} by {favorite_opportunity_id}

Request URL

https://{client_id}.salesseek.net/api/users/887766/favorite_opportunities/3-65a5d026  

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Favorite_opportunity_idInYThe id of Favorite_opportunity to be deletedstring

 

 


 

Get /users/{user_id}/deals

Provides the list of deals owned by this User 

Provides the list of Deals owned by this User 

Request URL

https://{client_id}.salesseek.net/api/users/69d1f4ae62/deals

Response Type

Response content type: JSON Array[Opportunities]

ModelExample of Response
Array[opportunities]


Opportunity (JSON) {

currency(Enum): 3 letters abbreviation for the currency affecting all revenue buckets of this deal,

expected_close_date(timestamp): estimated close date for this deal, formatted as YYYY-MM-ddThh_mm_ss.msecs,

id (string): unique identifier for this opportunity,

name(string): Deal's name to be shown,

phase(Phase): details about the specific Funnel Phase this deal is,

buckets(Array[Buckets]): List of revenue bucket for this current deal,

custom_fields (Associative Array): Associative array organised in pairs of id: value,

default_value(number): ?????,

latest_activity_in_days(int): Amount of days since the last activity over this deal,

organization(Organization): A deal is always related to an organization (required),

organization_id: unique identifier for the organization the deal is associated,

owner(Owner): each deal has a SalesSeek user who owns it (is responsible of),

owner_id(string): unique identifier for the SalesSeek user who owns this deal,

permissions: [???],

phase_id(string): id of the Funnel Phase this deal is,

phase_last_changed(timestamp): creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

phase_name(string): name of the Funnel Phase this deal is,

phase_number(int): position number of the Funnel Phase this deal is,

short_id(string): Alias which can be used as a unique identifier for the Bucket,

type(string): "opportunities",

value(number): total deal's size: sum of all bucket values,

comments(string): additional generic information not included on other fields (or custom fields),

is_favorite(boolean): true or false if this deal is favorite for the current SalesSeek user

}

 

Buckets(JSON): {

id (string): unique identifier for this bucket,

name (int): bucket name to be shown,

value (number): value for the current bucket inside this deal (depends on the currency),

default_value (string): ???

}

Organization(JSON): {

id (string): unique identifier for this organization,

name (int): organization name to be shown

}

Owner(JSON): {

id (string): unique identifier for the SalesSeek user who owns this deal,

name (int): name of the SalesSeek user who owns this deal

}

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

}

[
  {
    abbreviation: "F25"
    buckets: [
      0:{
        name:New Structure, 
        value:75000, 
        default_value:75000, 
        id:7d2e38b6d
      },
      1:{…}
    ]
    currency: "USD"
    custom_fields: {
      128d597afb923a:"https://www.google.com/NewStructure"
    }
    default_value: 75000
    expected_close_date: "2014-01-29T23:00:00"
    id: "184ffbf0aad9"
    latest_activity_in_days: 3
    name: "Refurbishing Opera House"
    organization: {
      id: "8d6455f0c6"
      name: "Opera House"
    }
    organization_id: "8d6455f0c6"
    owner: {
      id: "2901f25"
      name: "Anna Karina"
    }
    owner_id: "2901f25"
    permissions: [
      0: "salesseek.core.view",
      1: "salesseek.core.all_permissions",
      2: "salesseek.core.edit"
    ]
    phase: {
      id: "5b540b026a8"
      name: "Scheduled Visit"
      order: 2
    }
    phase_id: "5b540b026a8"
    phase_last_changed: "2014-01-18T12:26:30.055763"
    phase_name: "Scheduled visit"
    phase_number: 2
    short_id: "5b540b028"
    type: "opportunities"
    value: 75000
  },
  1:{...
  }
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Records-RowsOut-

Amount of records returned in this search

int
Records-StartOut-The index of the first row on the response (in case there are more results, paginated)int
Records-TotalOut-Total amount of records (even if are not in this search result)int
responseOut-Resulting list of Favorite OpportunitiesArray[Opportunities]

 


 

Get /users/{user_id}/forecasts

Provides the entire list of Forecasts 

Returns the entire list of  Forecasts .

A forecast is a list of deals containing estimations about the closing probability, might be using an automatic weight based on the deal's phase or unweighted, ie: based on the sales person intuition.

Request URL

https://{client_id}.salesseek.net/api/88384774/forecasts?detail=normal&published=true&rows=1&order_by=published_date+desc  

Response Type

Response content type: JSON Array[Forecast]

ModelExample of Response

Array[Forecast]

 

Forecast (JSON) {

currencies_conversion(Currencies): list of configured currencies conversion rates for this client,

id(string): unique identifier for this forecast,

is_most_recent(boolean): true or false if this forecast is the latest one for the current SalesSeek User (false by default),

name(string): Name of this forecast,

owner(User): Basic information from the owner of this forecast,

period(Period): Information about the period this forecast includes,

permissions(Permissions): List of allowed permissions over this forecast for the current SalesSeek user,

published(boolean): True or false if has been configured as the unique public forecast for this user,

short_id(string): alias: shorter but still unique identifier for this forecast,

type(string): "forecasts"

}

Currencies (AssociativeCollection)

{

/* List of Pairs of <Key> and <Value>, relates a currency Key with an exchange rate to be converted to the default currency*/

<Value>(number): vale of the conversion rate from this currency to the default currency, ie: if the default currency is USD, GBP can be added with an aprox value of 0.62,

<Key>(string): 3 chars id for the currency, check the following table for all available currencies:

 Click here for all available currencies...

Key

Currency Name

AUD

Australian Dollar
BRLBrasilian Real
CADCanadian Dollar
CHFSwiss Franc
CLPChilean Peso
CNY

Chinese Yuan

CZKCzech Koruna
DKKDanish Krone
EUREuro
FJDFiji Dollar
GBPBritish Pound
HKDHong Kong Dollar
HNLHonduran Lempira
HUFHungarian Forint
IDRIndonesian Rupiah
ILSIsraeli New Shekel
INRIndonesian Rupee
ISKIceland Krona
JPYJapansese Yen
KRWKorean Won
MXNMexican Peso
MYRMalasyan Ringgit
NOKNorwegian Krone
NZDNew Zealand Dollar
PHPPhilippine Peso
PKRPakistan Rupee
PLNPolish Zloty
RUBRussian Ruble
SEKSwedish Krona
SGDSingapore Dollar
THBThai Baht
TRYTurkish Lira
TWDTaiwan Dollar
ZARSouth Africa Rand
 }

Period (JSON) {

/* Depending on the SalesSeek account configuration a period can be a month or a quarter */

id(string): Unique ID for this period,

start_date(string): Forecast starting day, formatted as YYYY-MM-dd

name(string): Text identifying the current forecast, formatted as:

- YYYYFY QX for quarters, eg: 2014FY Q1

 - YYYYFY MX for months, eg: 2014FY M1

}

 

Forecast_Opportunity (JSON)  {

forecast_opportunity_buckets(Array[Forecast_Opportunity_Buckets]): List of oportunity buckets for this current deal,

id (string): unique identifier for this forecast opportunity,

opportunity(Opportunity),

opportunity_id (string): unique identifier for the actual opportunity in SalesSeek system this specific forecast opportunity is related to,

status(Enum): This is an estimation on the closing probability for this opportunity, usually set by its owner based on his intuition, could be: commited, commited downside, upside, none

weight(number): estimations about the closing probability could be weight based: a percentage from 0..1 based on the Sales Funnel Phases weights configured in SalesSeek System,

or manually updated,

}

 

Opportunity (JSON) {

currency(Enum): 3 letters abbreviation for the currency affecting all revenue buckets of this deal,

expected_close_date(timestamp): estimated close date for this deal, formatted as YYYY-MM-ddThh_mm_ss.msecs,

id (string): unique identifier for this opportunity,

name(string): Deal's name to be shown,

phase(Phase): details about the specific Funnel Phase this deal is,

}

 

Forecast_Opportunity_Buckets(JSON): {

id (string): unique identifier for this forecast bucket,

bucket_id (string): id of the real bucket this is associated to,

value (number): value for the current bucket inside this deal (depends on the currency),

}

 

Phase(JSON): {

id(string): id of the Funnel Phase this deal is,

name(string): name of the Funnel Phase this deal is,

order(int): position number of the Funnel Phase this deal is(starting from 1),

phase_type(Enum): there are 3 different type of phases:

  • user: if this is an active deal,
  • won: if the deal was closed as won,
  • lost: if the deal was closed as lost

}


 

User {

id (string): unique identifier for the User,

name (string): name to be shown,

}

 

Permissions (Array[string]): List of Permissions for the current SalesSeek User over the requested element, may include:

{

Permision ValueDescription
salesseek.core.all_permissionsAll Permission: to delete, change owner and change permisions, edit and view
salesseek.core.editPermission to edit and view
salesseek.core.viewPermissions to view

}

 

[
  0:{
    currencies_conversion: {
        AUD: "2",
        BRL: "3",
        currency: "USD"
    }
    id: "041513321",
    is_most_recent: true,
    name: "Jacks Forecast Q1"
    owner: {
        id: "2901445",
        name: "Jack Sparrow"
    }
    period: {
        id: "cf44542292",
        name: "2014FY Q1",
        start_date: "2014-07-01"
    }
    permissions: [
        0: "salesseek.core.all_permissions",
        1: "salesseek.core.edit",
        2: "salesseek.core.view"
    ]
    published: false,
    published_date: null,
    short_id: "041cdf88f",
    type: "forecasts"
  },
  1:{....}
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
Records-RowsOut-

Amount of records returned in this search

int
Records-StartOut-The index of the first row on the response (in case there are more results, paginated)int
Records-TotalOut-Total amount of records (even if are not in this search result)int
rowsInNThe maximum amount of element to be requestedint
startInNThe element number to start to retrieve the data (0 for the first position)int
order_byInN

Results are ordered by the provided field name followed by &20desc or &20asc,

in case nothing is provided it will be the creation date descendant

int
my_teamInNTrue or false if the expected list includes the forecast from every SalesSeek user under the current's user hierarchyboolean
publishedInNTrue or false if the expected list will include the only the published forecastsboolean
responseOut-Resulting list of ForecastsArray[Forecast]

 

 


 

Get /{user_id}/dashboard/sales_manager/teams

Provides the entire users' team under the sales manager hierarchy

Returns a list of teams

Request URL

https://{client_id}.salesseek.net/api/users/887744/dashboard/sales_manager/teams

Response Type

Response content type: JSON array[Team/User]

ModelExample of Response

Team_For_Dashboard (JSON) {

depth (int): How many parent levels are above this team on the users hierarchy,

id (string): unique identifier for this team,

manager (User): info about the manager of the current team,

members (Array[User]): Entire list of team members belonging the current team,

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

name (string): name to be shown,

parent_id (string): id of the User who is the parent of this team,

type (string): "teams"

}

User {

id (string): unique identifier for the User,

name (string): name to be shown,

type (string): "user"

short_id (string): Alias which can be used as a unique identifier for the User,

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

statistics (Statistic): Summary of the activities done by this user over the last 7 days

}

Statistics (JSON) {
activities (Activities): Group of activities run by this user,
opportunities (Opportunity) : Short summary about the closed deals
}
Activities(JSON) {
total (int): Total number of activities run by this user regardless of their type,
with_communication_medium(Communication_Medium) : amount of activities grouped by communication medium (phone or email)
}
Communication_Medium (JSON) {
email(int): amount of emails sent by this user during the last 7 days,
phone(int): amount of calls done by this user during the last 7 days
}
Opportunities(JSON) {
won(JSON): {
total_value(number): sum of all closed deals from the last 7 days
}
}

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

}

[
  0:{
    depth: 0,
    id: "d266a5d026",
    manager: {
   		id: "640cbcf25",
		name: "Anna Jones",
		quota: [
   			0: {"value": 10.0, "bucket_id": "991cdb6"},
   			1: {"value": 20.0, "bucket_id": "8bc7f383"},
       		2: {"value": 30.0, "bucket_id": "7aa206286"}
  		],
		short_id: "e9a2e667e2"
		statistics: {
			activities: {
				total: 4
				with_communication_medium: {
					email: 2
					phone: 1
				}
			opportunities: {
				won: {
					total_value: 1240000
				}
			}
		}
		type: "users"


    }
    members: []
    short_id: "d2665a5d026"
    name: "Sophia's Team"
    owner_id: "35235325",
    parent_id: "524535"
    type: "teams" 
  }
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
responseOut-Resulting list of Teams Below the current user hierarchyArray[Teams]
  • No labels