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

 

Get /groups

Provides the entire list of groups

Returns the entire list of  groups. Groups are part of the workspace, containing Individuals for easily working with them in batches. This list of groups may contain static groups or smart groups.

Request URL

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

Response Type

Response content type: JSON Array[Groups]

ModelExample of Response
Array[Groups]

Group  {

cost (double): Cost associated to get this group,

comments (string): additional comments about this group,

cost_basis (Enum): directly related wit the cost field, in case its specified this represents if that cost is for the entire group (total) or if the cost is per lead (cpl),

group_type (Enum): Can be static or smart depending if the group is static snapshot list of elements (added manually), or a list of filters to apply a s a live query to get the elements

element_type (Enum): Can be one of the following "Individuals", "Organizations" or "Deals" depending on the type of items to be inserted into this group

id (string): unique identifier for this group,

owner_id (string): unique id from the SalesSeek user who is the owner of this group (by default the creator)

name (int): group name to be shown,

permision (Array): ???,

columns (Array): Array of columns to be shown,

filter_id (string): unique ID for the set of filters applyed,

}

[
  0:{
    cost: 100,
    comments: "All users from the UK",
    element_type:"individuals",
    cost_basis: "total",
    filter_id:"338734"
    group_type: "smart"
    id: "ee3b271a38",
    name: "UK Contacts",
    owner_id: "23532341",
    permissions: [
      0: "salesseek.core.all_permissions",
      1: "salesseek.core.edit",
      2: "salesseek.core.view"
    ],
    columns: [],
  },
  1: {
    cost: 0,
    comments:"",
    cost_basis: "total",
    element_type:"organizations",
    group_type: "static"
    id: "5262be4ca6",
    name: "organizations",
    permissions: [
      0: "salesseek.core.all_permissions",
      1: "salesseek.core.edit",
      2: "salesseek.core.view"
    ],
    columns: [
      0: "name",
      1: "email",
      2: "phone",
      3: "custom_fields.ef02a9e8-2a1b-4830-854e-8c343b985579"
    ]
  }
]

 

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

 


 

POST  /groups

Creates a new static group

Creates a new group based on the information provided in the request body

 

Request URL

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

Request Body
{
    cost: 100,
    comments: "Users registered on our website, from natural search",
    cost_basis: "total",
    element_type: "individuals",
    name: "Web Registrants",
    group_type: "static"
}

 

Response Type

Response content type: JSON group

ModelExample of Response

 

Group  {

cost (double): Cost associated to get this group,

comments (string): additional comments about this group,

cost_basis (Enum): directly related wit the cost field, in case its specified this represents if that cost is for the entire group (total) or if the cost is per lead (cpl),

group_type (Enum): Can be static or smart depending if the group is static snapshot list of elements (added manually), or a list of filters to apply a s a live query to get the elements

element_type (Enum): Can be one of the following "Individuals", "Organizations" or "Deals" depending on the type of items to be inserted into this group

id (string): unique identifier for this group,

owner_id (string): unique id from the SalesSeek user who is the owner of this group (by default the creator)

name (int): group name to be shown,

permision (Array): ???,

columns (Array): Array of columns to be shown,

filter_id (string): unique ID for the set of filters applyed,

}

{
    columns: [],
    cost: 100,
    comments: "Users registered on our website, from natural search",
    cost_basis: "total",
    element_type: "individuals",
    id: "ee3b271a39",
    name: "Web Registrants",
    permissions: [
      0: "salesseek.core.all_permissions",
      1: "salesseek.core.edit",
      2: "salesseek.core.view"
    ]
    short_id: "ee3bda39",
    group_type: "static"
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
groupOut-The  group  created after the successful request

 

JSON
groupInYBasic fields for creating a new groupJSON

 


 

 

DELETE /groups

Deletes a list of group by their IDs

Deletes a specific list groups specifying the list of IDs

Request URL

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

Request Body
{
    0:{id: "fc8631c6c"},
    1:{id: "fc8635455"}
}

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 group_idsInYThe id of  group  to be deletedArray[ids]

 


 

Get /groups/{group _id} 

Provides the group matching group _id

Returns the unique  group matching the group _Id

Request URL

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

Response Type

Response content type: JSON(Group)

ModelExample of Response

 

Group  {

cost (double): Cost associated to get this group,

comments (string): additional comments about this group,

cost_basis (Enum): directly related wit the cost field, in case its specified this represents if that cost is for the entire group (total) or if the cost is per lead (cpl),

group_type (Enum): Can be static or smart depending if the group is static snapshot list of elements (added manually), or a list of filters to apply a s a live query to get the elements

element_type (Enum): Can be one of the following "Individuals", "Organizations" or "Deals" depending on the type of items to be inserted into this group

id (string): unique identifier for this group,

owner_id (string): unique id from the SalesSeek user who is the owner of this group (by default the creator)

name (int): group name to be shown,

permision (Array): ???,

columns (Array): Array of columns to be shown,

filter_id (string): unique ID for the set of filters applyed,

}

{
    cost: 0,
    comments:"",
    cost_basis: "total",
    element_type:"organizations",
    group_type: "static"
    id: "69d1fbe62",
    name: "organizations",
    permissions: [
      0: "salesseek.core.all_permissions",
      1: "salesseek.core.edit",
      2: "salesseek.core.view"
    ],
    columns: [
      0: "name",
      1: "email",
      2: "phone",
      3: "custom_fields.ef02a9e8-2a1b-4830-854e-8c343b985579"
    ]
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 group  _idInYThe id of the group to be obtainedstring
 group Out-The  requested  group  JSON

 


 

PATCH /groups/{group _id}

Update a specific  group  by its ID

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

Request URL

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

Request Body
{
    comments: "All users from California",
    cost: 200,
    name: "Users From California"
}

Response Type

Response content type: JSON group

ModelExample of Response

 

Group  {

cost (double): Cost associated to get this group,

comments (string): additional comments about this group,

cost_basis (Enum): directly related wit the cost field, in case its specified this represents if that cost is for the entire group (total) or if the cost is per lead (cpl),

group_type (Enum): Can be static or smart depending if the group is static snapshot list of elements (added manually), or a list of filters to apply a s a live query to get the elements

element_type (Enum): Can be one of the following "Individuals", "Organizations" or "Deals" depending on the type of items to be inserted into this group

id (string): unique identifier for this group,

owner_id (string): unique id from the SalesSeek user who is the owner of this group (by default the creator)

name (int): group name to be shown,

permision (Array): ???,

columns (Array): Array of columns to be shown,

filter_id (string): unique ID for the set of filters applyed,

}

{
    cost: 200,
    columns: [],
    comments: "All users from California",
    cost_basis: "total",
    id: "a3451f5",
    owner_id: "34343b5",
    name: "Users From California",
    permissions: [
      0: "salesseek.core.all_permissions",
      1: "salesseek.core.edit",
      2: "salesseek.core.view"
    ]
    short_id: "a3451f5",
    group_type: "static"
}

Parameters

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

 


 

DELETE /groups/{group _id}

Deletes a specific group by its ID

Deletes a specific group by its {group _id}

Request URL

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

Response Type

Response content type: null

 

Parameters

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

 


 


 

 


 

DELETE /groups/{group_id}/items

Removes a list of items from a group by their IDs

Removes a list of items from the group by their IDs

Request URL

https://{client_id}.salesseek.net/api//groups/88966/individuals

Request Body
{
    0:{id: "fc8631c6c"},
    1:{id: "fc8635455"}
}

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 group _idInYThe id of  group string
items_idsInYThe list of Items IDs to be excluded from the groupArray[ids]
  • No labels