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

Request Body

 

Get /organizations

Provides the entire list of  organizations

Returns the entire list of  organizations.

Opportunities and users may be related to one organization.

 

Request URL

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

Response Type

Response content type: JSON array[  organizations ]

ModelExample of Response

array[organizations ]

Organization  {

communication(Array[Communication]): The list of ways to communicate with this organization, including email, phone, LinkedIn, Facebook, Twitter and GooglePlus,

id (string): unique identifier for this bucket,

name (string): organization name to be shown,

permissions(Array): [] ???

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

custom_fields(Associative Array): {

CustomFieldId1(String): CustomFieldValue1(String),

CustomFieldId2(String): CustomFieldValue2(String),

...

}

Communication(JSON) {

id(string): unique identifier for the communication,

comments(string): text with the comments of this communication,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}


[
  0:{communication: [
    0:{
      name:Work,
      medium:phone,
      value:+155448855,
      comments:from 8:00 to 17:00
    },
    1: {
      name:Work,
      medium:email,
      value:minion@gmail.com,
      comments:From Mon to Sat
    },
    2: {
      medium:social,
      name:linkedin,
      value:https://www.linkedin.com/in/minrome/en
    },
    3: {
      medium:social,
      name:twitter,
      value:https://twitter.com/SalesSeek
    },
    4: {
      medium:social,
      name:facebook,
      value:https://www.facebook.com/SalesSeek?fref=ts
    },
    5: {
      medium:social,
      name:googleplus,
      value:https://plus.google.com/u/1/109741424567872838/posts
    }
  ]
  custom_fields: {},
  id: "466d6ce1-2846-4e5f-9379-50ff4364475a",
  name: "BaseHunters",
  permissions: [
    0: "salesseek.core.all_permissions"
    1: "salesseek.core.edit"
    2: "salesseek.core.view"
  ]
  short_id: "466d6ce1-2846-4e5f-9379-50ff4364475a"
]

 

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_byInNResults are ordered by the provided field name followed by &20desc or &20ascint

 

 


 

Get /organizations?search=name_string

Provides the the subset of organizations which name matches the name_string

Provides the the subset of organizations which name matches the name_substring. As it is intended to be used in searches then the set of information from each organization is limited.

Request URL

https://{client_id}.salesseek.net/api/organizations?search=hu

Response Type

Response content type: JSON Array[organization]

ModelExample of Response

Array[Organizations]

Organization  {

id (string): unique identifier for this Organization,

permissions(Array): [] ???

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

thumbnail(string): entire url for an image representing this organization,

titile(string): deal name to be shown as search result,

title_highlight(string): organization name to be shown as search result including HTML tag <em> surrounding the substring matching the search filter

type(string): "salesseek.opportunities.models.opportunity.Opportunity"

}

[
  0:{
    id: "466d6ce1-2846-4e5f-9379-50ff4364475a"
    permissions: [
      0: "salesseek.core.all_permissions"
      1: "salesseek.core.edit"
      2: "salesseek.core"
    ]
    short_id: "466d6ce1-2846-4e5f-9379-50ff4364475a"
    thumbnail: ""
    title: "BaseHunters"
    title_highlight: "Base<em>Hu</em>nters"
    type: "salesseek.contacts.models.organization.Organization"
  },
  1:{...
  }
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
searchInYString used for searching all deals which name contains the value of this parameterstring

 


 

 

POST  /organizations

Creates a new  organization 

Creates a new organization and returns the resulting one. 

 

Request URL

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

Request Body
{
  comments: "This company is completely focused on marketing"
  communication: [
    0:{
      name:Work,
      medium:phone,
      value:+155448855,
      comments:from 8:00 to 17:00
    },
    1: {
      name:Work,
      medium:email,
      value:minion@gmail.com,
      comments:From Mon to Sat
    },
    2: {
      medium:social,
      name:linkedin,
      value:https://www.linkedin.com/in/minrome/en
    },
    3: {
      medium:social,
      name:twitter,
      value:https://twitter.com/SalesSeek
    },
    4: {
      medium:social,
      name:facebook,
      value:https://www.facebook.com/SalesSeek?fref=ts
    },
    5: {
      medium:social,
      name:googleplus,
      value:https://plus.google.com/u/1/109741422872838/posts
    }
  ]
  locations: [
    0: {
      address: "212B Baker Street"
      comments: "Mon to Fri"
    }
  ]
  name: "Atila Tech"
  roles: []
}

 

Response Type

Response content type: JSON organization

ModelExample of Response

Organization  {

communication(Array[Communication]): The list of ways to communicate with this organization, including email, phone, LinkedIn, Facebook, Twitter and GooglePlus,

id (string): unique identifier for this bucket,

name (string): organization name to be shown,

permissions(Array): [] ???

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

custom_fields(Associative Array): {

CustomFieldId1(String): CustomFieldValue1(String),

CustomFieldId2(String): CustomFieldValue2(String),

...

abbreviation(string): unique identifier automatically generated for this organization (maximum length: 3 chars),

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

locations(Array[Locations])

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

}

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

}

Location  {

comments(string):Additional information related to the location, eg: working hours,

name(string): Text identifier for this location, eg: Home, Work, etc,

id (string): unique identifier for this location,

address(string): Complete Address

 }

Communication(JSON) {

id(string): unique identifier for the communication,

comments(string): text with the comments of this communication,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}


{
  abbreviation: "ATT"
  comments: "This company is completely focused on marketing"
  communication: [
    0:{
      name:Work,
      medium:phone,
      value:+155448855,
      comments:from 8:00 to 17:00
    },
    1: {
      name:Work,
      medium:email,
      value:minion@gmail.com,
      comments:From Mon to Sat
    },
    2: {
      medium:social,
      name:linkedin,
      value:https://www.linkedin.com/in/minrome/en
    },
    3: {
      medium:social,
      name:twitter,
      value:https://twitter.com/SalesSeek
    },
    4: {
      medium:social,
      name:facebook,
      value:https://www.facebook.com/SalesSeek?fref=ts
    },
    5: {
      medium:social,
      name:googleplus,
      value:https://plus.google.com/u/1/109741422872838/posts
    }
  ]
  custom_fields: {}
  id: "edd400ff1"
  locations: [
    0: {
      comments:Mon to Fri, 
      name:"Work", 
      id:b4792d25410292, 
      address:212B Baker Street
    }
  ]
  name: "Atila Tech"
  owner: {
    id: "2901bcf25"
    name: "Anna Karina 
  }
  permissions: [
    0: "salesseek.core.all_permissions"
    1: "salesseek.core.edit"
    2: "salesseek.core.view"
  ]
  short_id: "edd4e00ff1"
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
organizationOut-The organization created after the successful requestJSON

 


 

Get /organizations/{organization _id} 

Provides the organization matching organization _id

Returns the unique organization matching the  organization _Id

Request URL

https://{client_id}.salesseek.net/api/organizations/edd40ff1

Response Type

Response content type: Organization

ModelExample of Response

Organization  {

communication(Array[Communication]): The list of ways to communicate with this organization, including email, phone, LinkedIn, Facebook, Twitter and GooglePlus,

id (string): unique identifier for this bucket,

name (string): organization name to be shown,

permissions(Array): [] ???

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

custom_fields(Associative Array): {

CustomFieldId1(String): CustomFieldValue1(String),

CustomFieldId2(String): CustomFieldValue2(String),

...

abbreviation(string): unique identifier automatically generated for this organization (maximum length: 3 chars),

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

locations(Array[Locations])

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

}

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

}

Location  {

comments(string):Additional information related to the location, eg: working hours,

name(string): Text identifier for this location, eg: Home, Work, etc,

id (string): unique identifier for this location,

address(string): Complete Address

 }

Communication(JSON) {

id(string): unique identifier for the communication,

comments(string): text with the comments of this communication,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}


{
  abbreviation: "ATT"
  comments: "This company is completely focused on marketing"
  communication: [
    0:{
      name:Work,
      medium:phone,
      value:+155448855,
      comments:from 8:00 to 17:00
    },
    1: {
      name:Work,
      medium:email,
      value:minion@gmail.com,
      comments:From Mon to Sat
    },
    2: {
      medium:social,
      name:linkedin,
      value:https://www.linkedin.com/in/minrome/en
    },
    3: {
      medium:social,
      name:twitter,
      value:https://twitter.com/SalesSeek
    },
    4: {
      medium:social,
      name:facebook,
      value:https://www.facebook.com/SalesSeek?fref=ts
    },
    5: {
      medium:social,
      name:googleplus,
      value:https://plus.google.com/u/1/109741422344567872838/posts
    }
  ]
  custom_fields: {}
  id: "edd40ff1"
  locations: [
    0: {
      comments:Mon to Fri, 
      name:"Work", 
      id:b479210292, 
      address:212B Baker Street
    }
  ]
  name: "Atila Tech"
  owner: {
    id: "2901bcf25"
    name: "Anna Karina 
  }
  permissions: [
    0: "salesseek.core.all_permissions"
    1: "salesseek.core.edit"
    2: "salesseek.core.view"
  ]
  short_id: "edd4e00ff1"
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 organization  _idInYThe id of   organization   to be getstring
 organization Out-The  requested  organization  JSON

 

 


 

 

PATCH /organizations/{organization _id}

Updates a specific organization by its ID

Updates an organization by {organization _id} and Returns the resulting organization . The fields updated are just the ones passed on the request body

Request URL

https://{client_id}.salesseek.net/api/organization/a3451f5--640585a5d026

Request Body
{
   owner_id: "7c83f91962c83e61",
   comments: "They are focused on marketing and develop viral campaigns in the UK",
   communication: [
    0:{
      name:Work,
      medium:phone,
      value:+155448855,
      comments:from 8:00 to 17:00
    },
    1:{
      name:Work,
      medium:phone,
      value:+155448855,
      comments:from 8:00 to 17:00
    },
    2: {
      name:Work,
      medium:email,
      value:minion@gmail.com,
      comments:From Mon to Sat
    },
    3: {
      medium:social,
      name:linkedin,
      value:https://www.linkedin.com/in/minrome/en
    },
    4: {
      medium:social,
      name:twitter,
      value:https://twitter.com/SalesSeek
    },
    5: {
      medium:social,
      name:facebook,
      value:https://www.facebook.com/SalesSeek?fref=ts
    },
    6: {
      medium:social,
      name:googleplus,
      value:https://plus.google.com/u/1/109741422344567872838/posts
    }
  ]
}

 

Response Type

Response content type: JSON organization

ModelExample of Response

Organization  {

communication(Array[Communication]): The list of ways to communicate with this organization, including email, phone, LinkedIn, Facebook, Twitter and GooglePlus,

id (string): unique identifier for this bucket,

name (string): organization name to be shown,

permissions(Array): [] ???

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

custom_fields(Associative Array): {

CustomFieldId1(String): CustomFieldValue1(String),

CustomFieldId2(String): CustomFieldValue2(String),

...

abbreviation(string): unique identifier automatically generated for this organization (maximum length: 3 chars),

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

locations(Array[Locations])

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

}

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

}

Location  {

comments(string):Additional information related to the location, eg: working hours,

name(string): Text identifier for this location, eg: Home, Work, etc,

id (string): unique identifier for this location,

address(string): Complete Address

 }

Communication(JSON) {

id(string): unique identifier for the communication,

comments(string): text with the comments of this communication,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}


{
  abbreviation: "ATT"
  comments: "Marketing and develop viral campaigns in the UK",
  communication: [
    0:{
      name:Work,
      medium:phone,
      value:+155448855,
      comments:from 8:00 to 17:00
    },
    1:{
      name:Work,
      medium:phone,
      value:+155448855,
      comments:from 8:00 to 17:00
    },
    2: {
      name:Work,
      medium:email,
      value:minion@gmail.com,
      comments:From Mon to Sat
    },
    3: {
      medium:social,
      name:linkedin,
      value:https://www.linkedin.com/in/minrome/en
    },
    4: {
      medium:social,
      name:twitter,
      value:https://twitter.com/SalesSeek
    },
    5: {
      medium:social,
      name:facebook,
      value:https://www.facebook.com/SalesSeek?fref=ts
    },
    6: {
      medium:social,
      name:googleplus,
      value:https://plus.google.com/u/1/109741422344567872838/posts
    }
  ]
  custom_fields: {}
  id: "edd40ff1"
  locations: [
    0: {
      comments:Mon to Fri, 
      name:"Work", 
      id:b479210292, 
      address:212B Baker Street
    }
  ]
  name: "Atila Tech"
  owner: {
    id: "7c83f91962c83e61",
    name: "John Donnald"
  }
  permissions: [
    0: "salesseek.core.all_permissions"
    1: "salesseek.core.edit"
    2: "salesseek.core.view"
  ]
  short_id: "edd4e00ff1"
}


Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 organization _idInYThe id of the  organization  to be updatedstring
 organization InYThe subset of the  organization  model fields to be updatedJSON
 organization OutThe  organization  after the successful updateJSON

 

 


 

DELETE /organizations/{organization _id}

Deletes a specific organization by its ID

Deletes an organization by {organization _id}

Request URL

https://{client_id}.salesseek.net/api/organizations/a3451f5  

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
organization _idInYThe id of the organization to be deletedstring

 


 

Get /organizations/{organization_id}/individuals 

Provides the list of  individuals related to this organization  

Provides the list of  individuals related to this  organization   

Request URL

https://{client_id}.salesseek.net/api/organizations/69d1f4ae62/individuals?start=0&rows=10&order_by=modified%20desc

Response Type

Response content type: JSON Array[individual]

ModelExample of Response
Array[individual]

Individual  {

comments(string): Specific text field for general information about this individual,

communication(Array[Communication]): The list of ways to communicate with this individual, including email, phone, LinkedIn, Facebook, Twitter and GooglePlus,

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

first_name(string): Individual first name,

id(string): unique identifier for this individual,

is_favorite(boolean): true or false if this individual is favorite for the current SalesSeek User (false by default),

locations(Array[Location]): List of addresses associated to this individual,

last_name(string): Individual last name,

modified(string): individual latest modification date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

organization_name(string): Organization Name this individual belongs to,

owner_id(string): ID for the SalesSeek User who owns this individual,

photo_url(string): entire url for an image assigned to this individual,

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

source(Source): Lead source of this individual if defined,

source_id(string): Lead Source ID for this individual, if defined,

type(string): "individuals",

permissions(Array[string]): [

0: "salesseek.core.all_permissions"

1: "salesseek.core.edit"

2: "salesseek.core.view"

],

custom_fields(Associative Array): {

CustomFieldId1(String): CustomFieldValue1(String),

CustomFieldId2(String): CustomFieldValue2(String),

...

}

}

Source(JSON): {

id(string): Lead Source ID for this individual, if defined,

name(string): Text name of the lead source associated to tis individual, if defined,

}

Location  {

comments(string):Additional information related to the location, eg: working hours,

name(string): Text identifier for this location, eg: Home, Work, etc,

id (string): unique identifier for this location,

address(string): Complete Address

 }

Communication(JSON) {

id(string): unique identifier for the communication,

comments(string): text with the comments of this communication,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}


[
  0:{
    id: "6b169999",
    is_favorite: false,
    first_name: "Min",
    last_name: "Rome",
    comments: "He is interested in developing new business in EMEA",
    created: "2014-01-15T19:36:56.597910",
    modified: "2014-01-15T19:36:56.597910",
    type: "individuals",
    custom_fields: {},
    locations: [
        0:{
            address: "20 Lake Road, London",
            name: "Work",
            organization_id: 8d6455af0c6
        }
    ]
    permissions: [
        0: "salesseek.core.all_permissions",
        1: "salesseek.core.edit",
        2: "salesseek.core.view",
    ]
    organization_id: "8d6455af0c6",
    organization_name: "LiveImp",
    photo_url: "http://creativepool.com/marketing/images/minions-1.jpg",
    roles: [
        0: {
            title:CMO,
            organization_id:8d6455af0c6
        }
    }
    source: {
        cost: 0,
        cost_basis: "total",
        default_owner: null,
        id: "5a8a23be-e6d4-43d9-849b-2d800b1c8d47",
        name: "Twitter",
        owner_id: null,
        short_id: "5a8a23be-e6d4-43d9-849b-2d800b1c8d47",
        system_type: "twitter",
        type: "lead_sources"
    }
    communication: [
        0:{
            name:Work,
            medium:phone,
            value:+155448855,
            comments:from 8:00 to 17:00
        }
        1: {
            name:Work,
            medium:email,
            value:minion@gmail.com,
            comments:From Mon to Sat
        }
        2: {
            medium:social,
            name:linkedin,
            value:https://www.linkedin.com/in/minrome/en
        }
        3: {
            medium:social,
            name:twitter,
            value:https://twitter.com/SalesSeek
        }
        4: {
            medium:social,
            name:facebook,
            value:https://www.facebook.com/SalesSeek?fref=ts
        }
        5: {
            medium:social,
            name:googleplus,
            value:https://plus.google.com/u/1/109741422344567872838/posts
        }
  }
,
  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_byInNResults are ordered by the provided field name followed by &20desc or &20ascint

 


 

 

POST /organizations/{organization_id}/individuals

Creates a new individual related to organization {organization_id}

Creates a new individual related to organization {organization_id}

Request URL

https://{client_id}.salesseek.net/api/organizations/888899/individuals  

Request Body
{
    first_name: "Sherlock",
    last_name: "Holmes",
    comments: "He is mainly interested in developing new business in EMEA",
    locations: [
        0:{
            address: "221B Baker Street, London",
            name: "Work",
            organization_id: 8d6455af0c6
        }
    ]
    organization_id: "8d6455af0c6",
    photo_url: "http://cdn.mhpbooks.com/uploads/2013/03/sherlock-holmes.jpg",
    roles: [
        0: {
            title:"Detective",
            organization_id:8d6455af0c6
        }
    }
    source: {
        cost: 0,
        cost_basis: "total",
        default_owner: null,
        id: "5a8a23be8d47",
        name: "Web",
        owner_id: null,
        short_id: "5a8a23bec8d47",
        system_type: "web",
        type: "lead_sources"
    }
    communication: [
        0:{
            name:Work,
            medium:phone,
            value:+155448855,
            comments:from 8:00 to 17:00}
        1: {
            name:Work,
            medium:email,
            value:minion@gmail.com,
            comments:From Mon to Sat}
        2: {
            medium:social,
            name:linkedin,
            value:https://www.linkedin.com/in/minrome/en}
        3: {
            medium:social,
            name:twitter,
            value:https://twitter.com/SalesSeek}
        4: {
            medium:social,
            name:facebook,
            value:https://www.facebook.com/SalesSeek?fref=ts}
        5: {
            medium:social,
            name:googleplus,
            value:https://plus.google.com/u/1/109741422344567872838/posts}
  }

Response Type

Response content type: JSON(Individual)

ModelExample of Response

Individual  {

comments(string): Specific text field for general information about this individual,

communication(Array[Communication]): The list of ways to communicate with this individual, including email, phone, LinkedIn, Facebook, Twitter and GooglePlus,

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

first_name(string): Individual first name,

id(string): unique identifier for this individual,

is_favorite(boolean): true or false if this individual is favorite for the current SalesSeek User (false by default),

locations(Array[Location]): List of addresses associated to this individual,

last_name(string): Individual last name,

modified(string): individual latest modification date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

organization_name(string): Organization Name this individual belongs to,

owner_id(string): ID for the SalesSeek User who owns this individual,

photo_url(string): entire url for an image assigned to this individual,

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

source(Source): Lead source of this individual if defined,

source_id(string): Lead Source ID for this individual, if defined,

type(string): "individuals",

permissions(Array[string]): [

0: "salesseek.core.all_permissions"

1: "salesseek.core.edit"

2: "salesseek.core.view"

],

custom_fields(Associative Array): {

CustomFieldId1(String): CustomFieldValue1(String),

CustomFieldId2(String): CustomFieldValue2(String),

...

}

}

Source(JSON): {

id(string): Lead Source ID for this individual, if defined,

name(string): Text name of the lead source associated to tis individual, if defined,

}

Location  {

comments(string):Additional information related to the location, eg: working hours,

name(string): Text identifier for this location, eg: Home, Work, etc,

id (string): unique identifier for this location,

address(string): Complete Address

 }

Communication(JSON) {

id(string): unique identifier for the communication,

comments(string): text with the comments of this communication,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}


{
    id: "6b169999",
    is_favorite: false,
    first_name: "Sherlock",
    last_name: "Holmes",
    comments: "He is mainly interested in developing new business in EMEA",
    created: "2014-01-15T19:36:56.597910",
    modified: "2014-01-15T19:36:56.597910",
    type: "individuals",
    custom_fields: {},
    locations: [
        0:{
            address: "221B Baker Street, London",
            name: "Work",
            organization_id: 8d6455af0c6
        }
    ]
    permissions: [
        0: "salesseek.core.all_permissions",
        1: "salesseek.core.edit",
        2: "salesseek.core.view",
    ]
    organization_id: "8d6455af0c6",
    organization_name: "LiveImp",
    photo_url: "http://cdn.mhpbooks.com/uploads/2013/03/sherlock-holmes.jpg",
    roles: [
        0: {
            title:"Detective",
            organization_id:8d6455af0c6
        }
    }
    source: {
        cost: 0,
        cost_basis: "total",
        default_owner: null,
        id: "5a8a23be-e6d4-43d9-849b-2d800b1c8d47",
        name: "Web",
        owner_id: null,
        short_id: "5a8a23be-e6d4-43d9-849b-2d800b1c8d47",
        system_type: "web",
        type: "lead_sources"
    }
    communication: [
        0:{
            name:Work,
            medium:phone,
            value:+155448855,
            comments:from 8:00 to 17:00
        }
        1: {
            name:Work,
            medium:email,
            value:minion@gmail.com,
            comments:From Mon to Sat
        }
        2: {
            medium:social,
            name:linkedin,
            value:https://www.linkedin.com/in/minrome/en
        }
        3: {
            medium:social,
            name:twitter,
            value:https://twitter.com/SalesSeek
        }
        4: {
            medium:social,
            name:facebook,
            value:https://www.facebook.com/SalesSeek?fref=ts
        }
        5: {
            medium:social,
            name:googleplus,
            value:https://plus.google.com/u/1/109741422344567872838/posts
        }
  }

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
individualOut-The individual created after the successful requestJSON

 


 

Get /organizations/{organization_id}/opportunities

Provides the list of opportunities associated to this organization 

Provides the list of opportunities associated to this organization 

Request URL

https://{client_id}.salesseek.net/api/organizations/69d1f4ae62/opportunities?start=0&rows=10&order_by=modified%20desc

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
order_byInNResults are ordered by the provided field name followed by &20desc or &20ascint

 


 

 

Get /organizations/{organization_id}/activities

Provides the list of activities associated to this organization 

Provides the list of activities associated to this organization 

Request URL

https://{client_id}.salesseek.net/api/organizations/69d1f4ae62/activities?start=0&rows=10&order_by=modified%20desc

Response Type

Response content type: JSON Array[Activities]

ModelExample of Response
Array[Activity]

Activity {

client_id (string): the unique reference to the SalesSeek Account

communication (JSON): {

(relationship with a communication way associated to an individual or organisation, could be an email, a phone number, etc)

client_id(string): the unique reference to the SalesSeek Account,

comments(string): text with the comments of this communication,

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

creator_id(string): the id of the communication creator (User),

id(string): unique identifier for the communication,

last_modified_by_id(string): id of the User who modified this activity (if any),

latest(boolean): true or false if this is the latest communication associated to this individual,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

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

type(string): communications,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}

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

 creator (JSON): {

email_address(string): unique email address identifying the user who created this activity),

id(string): unique identifier for the User who created the activity,

name(string): name of the user who created the activity,

}

creator_id: unique identifier for the User who created the activity,

id(string): unique identifier for this activity,

last_modified_by_id(string): unique identifier for the User who lately modified the activity,

latest(boolean): true or false if this is the latest activity for the current list,

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

note(string): text describing this activity, anything the user introduces manually or automatically generated when emailed someone or called someone

owner_id(string): unique identifier for the User who owns the activity, is typically the creator, but can be modified,

photo_url(string): entire url for an image assigned to the User who lately modified the activity,

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

target_date(timestamp): Due date for this activity (if set), formatted as YYYY-MM-ddThh_mm_ss.msecs,

target_type(string): an activity is always associated to a target (opportunities, individuals or organisations),

target_is_parent(boolean): true or false if the target has additional individuals associated to it,

type(string): "activities",

/*Depending on the target type of this activity then it should have one of the 3 following kind of fields*/

individual_deleted(boolean): true or false if the associated individual was deleted if the target was individuals,

individual_id(string): unique identifier of the associated individual if the target was individuals,

individual_name(string): name of the associated individual if the target was individuals,

individual_short_id(string): unique shorter identifier of the associated individual if the target was individuals,

opportunity_id(string): unique identifier of the associated individual if the target was opportunities,

opportunity_name(string): name of the associated individual if the target was opportunities,

opportunity_short_id(string): unique shorter identifier of the associated opportunity (deal) if the target was opportunities,

organization_id(string): unique identifier of the associated individual if the target was organizations,

organization_name(string): unique shorter identifier of the associated organization if the target was organizations,

organization_short_id(string): unique shorter identifier of the associated individual if the target was organizations,

}

[
  0:{
    client_id: "66990be5d6f",
    communication: {
        client_id: "669908c3-ce5d6f",
        comments: "",
        created: "2014-01-16T13:31:12.335177",
        creator_id: "2901efcbcf25",
        id: "945c06ec200",
        last_modified_by_id: "2901efbcf25",
        latest: true,
        medium: "email",
        modified: "2014-01-16T13:31:12.335177",
        name: "Work",
        type: "communications",
        value: "aleva@jacs.com",
         
    }
    created: "2014-01-18T16:21:31.680889",
    creator: {
        id:2901efb640cbcf25, 
        email_address:user1@gmail.com, 
        name:Kevin User 1
    }
    creator_id: "2901ef8bcf25",
    id: "c3418d621",
    organization_deleted: false,
    organization_id: "69d1f4ae62",
    organization_name: "Alex Van",
    organization_short_id: "69d1f3be62",
    last_modified_by_id: "2901efbcf25",
    latest: true,
    modified: "2014-01-18T16:21:31.680889",
    note: "emailed",
    opportunity_id: null,
    opportunity_name: null,
    opportunity_short_id: null,
    individual_id: null,
    individual_name: null,
    individual_short_id: null,
    owner_id: "2901ef0cbcf25",
    photo_url: "https://pbs.twimg.com/profile_images/10/Twitpic01.jpg",
    short_id: "c341806f621",
    target_date: null,
    target_is_parent: true,
    target_type: "organizations",
    type: "activities"
  }
,
  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_byInNResults are ordered by the provided field name followed by &20desc or &20ascint

 


 

POST /organizations/{organization_id}/activities

Creates a new Activity associated to organization {organization_id}

Creates a new Activity associated to organization {organization_id}

Request URL

https://{client_id}.salesseek.net/api/organizations/888899/activities

Request Body
{
	communication:{
		comments: "From Mon to Sat",
		id: "2f103f9f-8e0e-41c1-aa2d-47a4a32a536a",
		medium: "email",
		name: "Work",
		value: "info@atilatech.com",
	}
	note: "emailed"
}

 

Response Type

Response content type: JSON Activity

ModelExample of Response

Activity {

client_id (string): the unique reference to the SalesSeek Account

communication (JSON): {

(relationship with a communication way associated to an individual or organisation, could be an email, a phone number, etc)

client_id(string): the unique reference to the SalesSeek Account,

comments(string): text with the comments of this communication,

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

creator_id(string): the id of the communication creator (User),

id(string): unique identifier for the communication,

last_modified_by_id(string): id of the User who modified this activity (if any),

latest(boolean): true or false if this is the latest communication associated to this individual,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

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

type(string): communications,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}

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

 creator (JSON): {

email_address(string): unique email address identifying the user who created this activity),

id(string): unique identifier for the User who created the activity,

name(string): name of the user who created the activity,

}

creator_id: unique identifier for the User who created the activity,

id(string): unique identifier for this activity,

last_modified_by_id(string): unique identifier for the User who lately modified the activity,

latest(boolean): true or false if this is the latest activity for the current list,

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

note(string): text describing this activity, anything the user introduces manually or automatically generated when emailed someone or called someone

owner_id(string): unique identifier for the User who owns the activity, is typically the creator, but can be modified,

photo_url(string): entire url for an image assigned to the User who lately modified the activity,

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

target_date(timestamp): Due date for this activity (if set), formatted as YYYY-MM-ddThh_mm_ss.msecs,

target_type(string): an activity is always associated to a target (opportunities, individuals or organisations),

target_is_parent(boolean): true or false if the target has additional individuals associated to it,

type(string): "activities",

/*Depending on the target type of this activity then it should have one of the 3 following kind of fields*/

individual_deleted(boolean): true or false if the associated individual was deleted if the target was individuals,

individual_id(string): unique identifier of the associated individual if the target was individuals,

individual_name(string): name of the associated individual if the target was individuals,

individual_short_id(string): unique shorter identifier of the associated individual if the target was individuals,

opportunity_id(string): unique identifier of the associated individual if the target was opportunities,

opportunity_name(string): name of the associated individual if the target was opportunities,

opportunity_short_id(string): unique shorter identifier of the associated opportunity (deal) if the target was opportunities,

organization_id(string): unique identifier of the associated individual if the target was organizations,

organization_name(string): unique shorter identifier of the associated organization if the target was organizations,

organization_short_id(string): unique shorter identifier of the associated individual if the target was organizations,

}

{
	client_id: "6699e5d6f"
	communication: {
		client_id: "6699e5d6f"
		comments: "From Mon to Sat"
		created: "2014-01-19T19:36:56.597910"
		creator_id: "2901ecbcf25"
		id: "2f1a536a"
		last_modified_by_id: "2901ecbcf25"
		latest: true
		medium: "email"
		modified: "2014-09-19T20:38:03.373365"
		name: "Work"
		owner_id: "2901ecbcf25"
		type: "communications"
		value: "info@atilatech.com"
	}
	created: "2014-01-19T20:48:03.810141"
	creator: {
		email_address: "ann@gmail.com"
		id: "2901ecbcf25"
		name: "Anna Karina"
	}
	creator_id: "2901ecbcf25"
	id: "9cbede5871"
	organization_deleted: false
	organization_id: "6b1664bbf95"
	organization_name: "Atila Tech"
	organization_short_id: "6b1664bb5"
	last_modified_by_id: "2901ecbcf25"
	latest: true
	modified: "2014-01-19T20:48:03.810141"
	note: "emailed"
	opportunity_id: null
	opportunity_name: null
	opportunity_short_id: null
	individual_id: null
	individual_name: null
	individual_short_id: null
	owner_id: "2901ecbcf25"
	photo_url: "http://creativepool.com/marketing/images/minions-1.jpg"
	short_id: "9cbed4e5871"
	target_date: null
	target_is_parent: true
	target_type: "organizations"
	type: "activities"
  }

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
ActivityOut-The  organization  created after the successful requestJSON

 


 

DELETE /organizations/{organization_id}/activities/{activity_id}

Deletes a specific Activity by its ID

Delete a specific Activity which is associated to the organization {activity_id} by {activity_id}

Request URL

https://{client_id}.salesseek.net/api/organizations/887766/activities/3-65a5d026  

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
activity_idInYThe id of activity to be deletedstring

 


 

PATCH /organizations/{organization _id}/activities/{activity_id}

Update a specific Activity by its ID, associated to an {organization_id}

Updates an Activity by its ID and assocaited {organization _id} and Returns the resulting  Activity . The fields updated are just the ones passed on the request body

Request URL

https://{client_id}.salesseek.net/api/organizations/69d1fbe62 

Request Body
{
  note: "Waiting for her response about the price"
}

 

Response Type

Response content type: JSON Activity

ModelExample of Response

Activity {

client_id (string): the unique reference to the SalesSeek Account

communication (JSON): {

(relationship with a communication way associated to an individual or organisation, could be an email, a phone number, etc)

client_id(string): the unique reference to the SalesSeek Account,

comments(string): text with the comments of this communication,

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

creator_id(string): the id of the communication creator (User),

id(string): unique identifier for the communication,

last_modified_by_id(string): id of the User who modified this activity (if any),

latest(boolean): true or false if this is the latest communication associated to this individual,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

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

type(string): communications,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}

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

 creator (JSON): {

email_address(string): unique email address identifying the user who created this activity),

id(string): unique identifier for the User who created the activity,

name(string): name of the user who created the activity,

}

creator_id: unique identifier for the User who created the activity,

id(string): unique identifier for this activity,

last_modified_by_id(string): unique identifier for the User who lately modified the activity,

latest(boolean): true or false if this is the latest activity for the current list,

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

note(string): text describing this activity, anything the user introduces manually or automatically generated when emailed someone or called someone

owner_id(string): unique identifier for the User who owns the activity, is typically the creator, but can be modified,

photo_url(string): entire url for an image assigned to the User who lately modified the activity,

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

target_date(timestamp): Due date for this activity (if set), formatted as YYYY-MM-ddThh_mm_ss.msecs,

target_type(string): an activity is always associated to a target (opportunities, individuals or organisations),

target_is_parent(boolean): true or false if the target has additional individuals associated to it,

type(string): "activities",

/*Depending on the target type of this activity then it should have one of the 3 following kind of fields*/

individual_deleted(boolean): true or false if the associated individual was deleted if the target was individuals,

individual_id(string): unique identifier of the associated individual if the target was individuals,

individual_name(string): name of the associated individual if the target was individuals,

individual_short_id(string): unique shorter identifier of the associated individual if the target was individuals,

opportunity_id(string): unique identifier of the associated individual if the target was opportunities,

opportunity_name(string): name of the associated individual if the target was opportunities,

opportunity_short_id(string): unique shorter identifier of the associated opportunity (deal) if the target was opportunities,

organization_id(string): unique identifier of the associated individual if the target was organizations,

organization_name(string): unique shorter identifier of the associated organization if the target was organizations,

organization_short_id(string): unique shorter identifier of the associated individual if the target was organizations,

}

{
	client_id: "6699e5d6f"
	communication: {
		client_id: "6699e5d6f"
		comments: "From Mon to Sat"
		created: "2014-01-19T19:36:56.597910"
		creator_id: "2901ecbcf25"
		id: "2f1a536a"
		last_modified_by_id: "2901ecbcf25"
		latest: true
		medium: "email"
		modified: "2014-09-19T20:38:03.373365"
		name: "Work"
		owner_id: "2901ecbcf25"
		type: "communications"
		value: "minion@gmail.com"
	}
	created: "2014-01-19T20:48:03.810141"
	creator: {
		email_address: "ann@gmail.com"
		id: "2901ecbcf25"
		name: "Anna Karina"
	}
	creator_id: "2901ecbcf25"
	id: "9cbede5871"
	organization_deleted: false
	organization_id: "6b1664bbf95"
	organization_name: "Min Rome"
	organization_short_id: "6b1664bb5"
	last_modified_by_id: "2901ecbcf25"
	latest: true
	modified: "2014-01-19T20:48:03.810141"
	note: "emailed"
	opportunity_id: null
	opportunity_name: null
	opportunity_short_id: null
	individual_id: null
	individual_name: null
	individual_short_id: null
	owner_id: "2901ecbcf25"
	photo_url: "http://creativepool.com/marketing/images/minions-1.jpg"
	short_id: "9cbed4e5871"
	target_date: null
	target_is_parent: true
	target_type: "organizations"
	type: "activities"
  }

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
user_idInYThe id of the  organization  which is associated this activitystring
activity_id InYThe id of the activity to be updatedJSON
Activity OutThe  organization  after the successful updateJSON
  • No labels