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

 

Get /activities

Provides the list of Activities

Returns a list of all Activities, an activity may be an email sent, a call, any action over sales system like change Deals Phase, Create new contact or a simple plain note. An activity might have a due date.

Request URL

https://{client_id}.salesseek.net/api/activities?start=0&rows=20&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,

}

[
  {
    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",
    individual_deleted: false,
    individual_id: "69d1f4ae62",
    individual_name: "Alex Van",
    individual_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,
    organization_id: null,
    organization_name: null,
    organization_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: "individuals",
    type: "activities"
  }
, 
  {
    client_id: "66995d6f",
    communication: {
      client_id: null,
      comments: null,
      created: null,
      creator_id: null,
      id: null,
      last_modified_by_id: null,
      latest: null,
      medium: null,
      modified: null,
      name: null,
      owner_id: null,
      type: "communications",
      value: null,
      version: null
    }
    created: "2014-01-16T13:35:34.508352",
    creator: {
      email_address: "kevin@gmail.com",
      id: "2901cf25",
      name: "Kevin User1",
    }
    creator_id: "2901efbcf25",
    id: "d938dbac",
    individual_deleted: null,
    individual_id: null,
    individual_name: null,
    individual_short_id: null,
    last_modified_by_id: "2901ecf25",
    latest: true,
    modified: "2014-01-16T13:35:34.508352",
    note: "Waiting for her response about the price",
    opportunity_id: "e96abe20c4",
    opportunity_name: "Jack Deal",
    opportunity_short_id: "e96a20c4",
    organization_id: null,
    organization_name: null,
    organization_short_id: null,
    owner_id: "2901e640cbcf25",
    photo_url: null,
    short_id: "d9387dbac",
    target_date: null,
    target_is_parent: false,
    target_type: "opportunities",
    type: "activities"
  }
]

 

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
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 &20asc int

 

 

 


 

DELETE /activities

Deletes a list of activities

Delete a list of Activities based on the provided Array of {activity_id}

Request URL

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

Request Body
[
  {"id": "88554461"},
  {"id": "88554462"},
  {"id": "88554463"}
]
 

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
activities_idsInYThe id of activities to be deletedArray[JSON]

 


 

DELETE /activities/{activity_id}

Deletes a specific Activity by its ID

Delete a specific Activity by {activity_id}

Request URL

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

Response Type

Response content type: null

 

Parameters

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

 


 

 

 

  • No labels