NAV Navbar
  • Introduction
  • Authentication
  • Organization API
  • Individual API
  • Deal API
  • Task API
  • Filter API
  • Group API
  • Group Page API
  • Campaign API
  • Activity API
  • Tag API
  • Custom Field API
  • User API
  • Introduction

    Welcome to the SalesSeek API. You can use our API to access all our API endpoints, such as the Deal API to look up deal values, or the Individual API to look up email addresses.

    The API is organized around REST. All requests should be made over SSL. All request and response bodies, including errors, are encoded in JSON.

    URIs for SalesSeek's REST API resource have the following structure:

    https://{CLIENT_ID}.salesseek.net/api/{RESOURCE}?{KEY1}={VALUE1}&{KEY2}={VALUE2}

    Variable Description
    CLIENT_ID The unique ID for your SalesSeek account. You can find this as the sub-domain when accessing your account.
    RESOURCE Specific resource type to be requested.
    KEYx Parameter identifier matching one resource's parameter
    VALUEx Value asociated to KEYx

    The SalesSeek application itself is developed using this API. Therefore it is possible to inspect the API calls that the application makes using your browser developer tools.

    Authentication

    SalesSeek uses cookies as the authentication method. Cookies are encrypted by the server in the HTTPS Response after login.

    SalesSeek expects the cookie to be included in all API requests to the server after login. For this reason the first step should be Login and then any sequence of requests to the API can follow.

    Authentication Attributes

    The JSON encoded response looks like this.

    {
      "id": "a938196a-152d-40f3-ab3d-404385143a4b",
      "name": "Example Login",
      "is_admin": true,
      "email_address": "example@salesseek.co.uk",
      "client_id": "913fa210-edf2-49c3-86a2-ec8f063d92ea",
      "client": {
        "created": "2017-03-07T17:33:48.856990",
        "currencies": {
          "AED": "0.5"
        },
        "default_currency": "GBP",
        "email_sending_domains": [
          "example.com"
        ],
        "facebook_page_id": null,
        "feature_tier": null,
        "marketing_groups": null,
        "name": "Example",
        "selective_unsubscribing": false,
        "short_id": "example",
      },
      "modified": "2017-04-27T15:57:34.916670",
      "created": "2017-03-13T10:41:37.403733",
      "ical_url": "/users/a938196a-152d-40f3-ab3d-404385143a4b/icalendar_feed?token=308e39c8-584f-402c-b5d2-4b9214be8424",
      "password_reset_required": false,
      "notification_settings": {
        "instant_email_notifications": "False",
        "evening_email_notification": "False",
        "morning_email_notification": "False",
        "new_lead_email_notification": "False"
      }
    }
    
    Parameter Description
    id The unique identifier for the User logging in String
    name The name of the User logging in String
    is_admin Set to true if this User is an admin Boolean
    email_address The User email address String
    client_id The unique identifier for the current SalesSeek account String
    client.created SalesSeek account creation timestamp Timestamp (ISO 8601)
    client.currencies The currencies and their conversions in this SalesSeek account Object
    client.default_currency The default currency for this account String
    client.email_sending_domains The domains that this SalesSeek account is authorized to send emails from (not user editable)Array (String)
    client.facebook_page_id The ID for the connected facebook page to this account String
    client.feature_tier The current tier that this SalesSeek account is registered to (starting, growing, enterprise)(not user editable) Enum (String)
    client.marketing_groups Array of IDs of the groups in this SalesSeek account which are mailing lists Array (String)
    client.name The name for this SalesSeek account String
    client.selective_unsubscribing Set to true if this account has selective unsubscribing enabled Boolean
    client.short_id The short ID for this SalesSeek account. Also used in the account subdomain String
    modified User last modified timestamp Timestamp (ISO 8601)
    created User creation timestamp Timestamp (ISO 8601)
    ical_url URL for the User iCal connection String (URL)
    password_reset_required Set to true if this User will be required to reset their password when loggin in Boolean
    notification_settings Object contianing users email notification settings Object
    notification_settings.instant_email_notifications Set to 'True' if user has instant email notifications when a task has been assigned to them enabled String
    notification_settings.evening_email_notification Set to 'True' if user has enabled a daily email of all completed tasks, and today's uncompleted tasks String
    notification_settings.morning_email_notification Set to 'True' if user has enabled a daily email with tasks that need completing today String
    notification_settings.new_lead_email_notification Set to 'True' if user has enabled a an email each time a new lead is assigned to them String

    Login

    When logging in you must add the following to the reqest header:

    Content-Type: application/x-www-form-urlencoded
    

    A sample request body to login as example user would be:

    {
      "email": "example@salesseek.com",
      "password": "V84gFHyAckt%b@bNRy$fW"
    }
    

    If login is successful, the following cookie will be present in the response header:

    Set-Cookie: salesseek=54fe7b67-a08a-4467-b95b-8689084b1f89; Path=/
    

    To login, send your email address and password to the endpoint below. If login is successful a cookie will be returned in the response header. This cookie should be used in all future calls to the API.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/login

    Request Body Parameters

    Parameter Description
    email_address Your email address used to access your account. String
    password The password used to access your account. String

    You must set the following Content-Type in the request header:
    Content-Type: application/x-www-form-urlencoded

    Logout

    Executes the logout process for the currently authenticated SalesSeek user

    Request URL

    DELETE https://{CLIENT_ID}.salesseek.net/api/logout

    Request Password Reset

    A sample request body to request a user password reset would be:

    {
      "email_address": "example@salesseek.com",
      "callback_url": "https://example.salesseek.net/#reset"
    }
    

    If a user has forgoten their password for their SalesSeek account make a call to this API to reset their password. After providing their email address SalesSeek will send link via email to validate this person wanted to change their password. The token sent in this email is requried to reset a password.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/forgotten

    Request Body Parameters

    Parameter Description
    email_address Your email address for the user that would like to reset their password. String
    callback_url The next web page to open after reset String

    Complete Password Reset

    A sample request body to complete the reset of a user password would be:

    {
        "user_id": "a938196a-152d-40f3-ab3d-404385143a4b",
        "token": "76ef98545e738a51",
        "password": "I_will_remember_this_new_password"
    }
    

    Once the password reset email has been received, the token in the email must be used to reset the user password.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/reset

    Request Body Parameters

    Parameter Description
    user_id The ID for the user to have the password reset. String
    token Unique token provided in reset confirmation email String
    password New password to be assigned to account String

    The token in the request confirmation email must be used to reset the user password.

    Organization API

    Organization Attributes

    The JSON encoded response looks like this.

    {
      "id": "84087907-6bf4-437a-aa52-200eb40aa5d2",
      "name": "Chiswick Marketing",
      "abbreviation": "CHM",
      "created": "2017-03-28T08:53:04.914564",
      "modified": "2017-03-28T08:53:04.914564",
      "creator_id": "7a7cb0c5-6222-4c70-8327-217e49f39e1e",
      "last_modified_by_id": "7a7cb0c5-6222-4c70-8327-217e49f39e1e",
      "owner_id": "7a7cb0c5-6222-4c70-8327-217e49f39e1e",
      "last_viewed": "2017-07-28T13:34:53.010019",
      "communication": [
      ],
      "locations": [
      ],
      "creator": {
      },
      "owner": {
      },
      "comments": "This is a comment",
      "tags": [
      ],
      "related_file_ids": [
      ],
      "is_favorite": false,
      "custom_fields": {
        "06bda654-4ca9-4e74-b616-8d3bb53706f0": "63effe75-b52b-4c92-a523-713c2f0e8be9"
      },
    }
    
    Parameter Description
    id The unique identifier for this organization String
    name The user provided name for the organization String
    abbreviation A system generated abbreviation, derived from the organization name String
    created Organization creation timestamp Timestamp (ISO 8601)
    modified Organization last modified timestamp Timestamp (ISO 8601)
    creator_id The unique ID for the SalesSeek User that created this organization String
    last_modified_by_id The unique ID for the SalesSeek User that last modified this organization String
    owner_id The unique ID for the SalesSeek User that has ownership of this organization String
    last_viewed Organization last viewed timestamp Timestamp (ISO 8601)
    communication An array containing the different communication methods associated with this organization Array (Object)
    locations An array containing the different locations associated with this organization Array (Object)
    creator Object containing detailed information about the User that created the organization Object
    owner Object containing detailed information about the User that has ownership over the organization Object
    comments User provided comments associated with this organization String
    tags User provided tags associated with this organization Array (Object)
    related_file_ids Array of Related File IDs associated with this organization Array (String)
    is_favorite Set to true if this organization is marked as a favorite Boolean
    custom_field.{custom_field_id} Contains the value for the Custom Field using the custom_field_id (Mixed)

    Get Organization

    Returns the unique organization matching the organization_id

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/organizations/{organization_id}

    Request Query Parameters

    Parameter Description
    organization_id The ID for the organization you'd like to retrieve

    Create Organization

    Creates a new organization and then returns the newly created organization.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/organizations

    Update Organization

    A sample request body to change the organization name would be:

    {
      "name": "Chiswick Marketing Ltd."
    }
    

    Updates values of organization by organization_id. The resulting organization is returned.

    Request URL

    PATCH https://{CLIENT_ID}.salesseek.net/api/organizations/{organization_id}

    Parameter Description
    organization_id The ID for the organization you'd like to update

    Request Body

    The only fields updated are the one passed on the request body JSON. You can pass any attribute to update.

    Delete Organization

    Deletes the organization matching the organization_id

    Request URL

    DELETE https://{CLIENT_ID}.salesseek.net/api/organizations/{organization_id}

    Request Query Parameters

    Parameter Description
    organization_id The unique ID for the organization to be deleted.

    List Organizations

    An example request to get the first 50 organizations in your SalesSeek (when ordered alphabetically by name) would be:

    GET https://example.salesseek.net/api/organizations?rows=50&start=0&order_by="name asc"
    

    The reponse header contains the following information:

    Records-Rows: 50
    Records-Start: 0
    Records-Total: 2000
    

    Returns a list of organizations from your SalesSeek account.

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/organizations

    Request Query Parameters

    Parameter Description
    rows The maximum number of organizations to be returned.
    start The row number to start to retrieve data. (0 for start)
    order_by Results are ordered by the provided field name followed by &desc or &asc

    The response header contains the total number of records.

    Response Header Parameters

    Parameter Description
    Records-Rows The number of rows returned in this request
    Records-Start The start number of rows in this request (out of total)
    Records-Total The total number of rows available

    Search Organizations

    An example request for organizations where the name contains 'example'

    https://example.salesseek.net/api/organizations?search=example
    

    Provides the the subset of organizations where the Organization name matches the search_string.

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/organizations?search={search_string}

    Request Query Parameters

    Parameter Description
    search_string Searches for all Organizations containing this string.

    The set of information returned is reduced to maintain search performance.

    Individual API

    To add a 'lead' to SalesSeek you should add an Indvidual and set the source field to a valid value. You can read more about this in our help centre article

    Individual Attributes

    The JSON encoded response looks like this.

    {
      "id": "e6b52466-69d8-41c5-b8c5-ab00de5865ac",
      "photo_url": "https://www.example.com/man.png",
      "first_name": "Aaron",
      "last_name": "Henlow",
      "full_name": "Aaron Henlow",
      "role": "Associate",
      "organization_name": "Riffroute",
      "organization_id": "3d4cd1a4-1a01-445c-84a7-b4d98643b4ce",
      "organization": {
        ...
      }
      "created": "2016-06-23T11:23:59.997891",
      "modified": "2017-01-23T14:16:04.309723",
      "creator_id": "247f5cd0-f6b7-42d3-8b01-47b1e1941fa9",
      "last_modified_by_id": "247f5cd0-f6b7-42d3-8b01-47b1e1941fa9",
      "owner_id": "247f5cd0-f6b7-42d3-8b01-47b1e1941fa9",
      "last_viewed": "2017-07-28T14:53:15.350053",
      "communication": [
        ...
      ],
      "locations": [
        ...
      ],
      "creator": {
        ...
      },
      "owner": {
        ...
      },
      "comments": "",
      "tags": [
      ],
      "related_file_ids": [
      ],
      "is_favorite": false,
      "custom_fields": {
        "a649e75e-cec4-49ad-bd75-0a249270065c": "35000",
        "aa00d7c8-3ab1-4315-929f-341d99e0f62d": "01/20/2017",
        "6163e374-97fa-4f81-b132-5f622ed24a1b": "true",
        "3c7db37f-66a0-4dfb-85cd-f51a5a9d509b": "4b0a7982-1471-499d-bbcb-6022dade415e"
      },
      "unsubscribed_all": false,
      "source_id": "500c679d-b859-4d51-8026-93ad946a5e45",
      "became_lead_date": "2016-06-23T11:24:00.043888",
      "source": {
        ...
      }, 
    }
    
    Parameter Description
    id The unique identifier for this individual String
    photo_url URL for the individual profile photo URL
    first_name Individual first name String
    last_name Individual last name String
    full_name Individual first name concatenated with last name String
    role Individual's Job Role String
    organization_name The name for the Organization this individual is linked to String
    organization_id The unique ID for the Organization this individual is linked to String
    organization Object containing detailed information about Organization this individual is linked to Object
    created Individual creation timestamp Timestamp (ISO 8601)
    modified Individual last modified timestamp Timestamp (ISO 8601)
    creator_id The unique ID for the SalesSeek User that created this individual String
    last_modified_by_id The unique ID for the SalesSeek User that last modified this individual String
    owner_id The unique ID for the SalesSeek User that has ownership of this individual String
    last_viewed Individual last viewed timestamp Timestamp (ISO 8601)
    communication An array containing the different communication methods associated with this individual Array (Object)
    locations An array containing the different locations associated with this individual Array (Object)
    creator Object containing detailed information about the User that created this individual Object
    owner Object containing detailed information about the User the has ownership over this individual Object
    comments User provided comments associated with this individual String
    tags User provided tags associated with this organization Array (Object)
    related_file_ids Array of Related File IDs associated with this individual Array (String)
    is_favorite Is this marked as a favorite? Boolean
    custom_field.{custom_field_id} Contains the value for the Custom Field using the custom_field_id (Mixed)
    unsubscribed_all Set to true if this individual has unsubscribed from all Campaigns Boolean
    source_id The ID for the associated lead source String
    became_lead_date Timestamp of the individual becoming a lead Timestamp (ISO 8601)
    source Detailed information about the associated lead source Object

    Get Individual

    Returns the individual matching the individual_id

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/individuals/{individual_id}

    Request Query Parameters

    Parameter Description
    individual_id The unique ID for the individual to be retrieved.

    Create Individual

    Creates a new Individual and returns the resulting Individual.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/individuals/

    Update Individual

    A sample request body to change the individual last name would be:

    {
      "last_name": "Seek"
    }
    

    Updates an Individual by individual_id and returns the resulting Individual.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/individuals/{individual_id}

    Request Query Parameters

    Parameter Description
    individual_id The unique ID for the individual to be updated.

    Request Body

    The only fields updated are the one passed on the request body JSON. You can pass any attribute to update.

    Delete Individual

    Deletes the individual matching the individual_id

    Request URL

    DELETE https://{CLIENT_ID}.salesseek.net/api/individuals/{individual_id}

    Request Query Parameters

    Parameter Description
    individual_id The unique ID for the individual to be updated.

    List Individuals

    An example request to get the first 50 individuals in your SalesSeek (when ordered by last modified) would be:

    GET https://example.salesseek.net/api/individuals?rows=50&start=0&order_by=modified%20desc
    

    The reponse header contains the following information:

    Records-Rows: 50
    Records-Start: 0
    Records-Total: 2000
    

    Returns the entire list of individuals from your SalesSeek account.

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/individuals

    Request Query Parameters

    Parameter Description
    rows The maximum number of organizations to be returned.
    start The row number to start to retrieve data. (0 for start)
    order_by Results are ordered by the provided field name followed by desc or asc

    Response Header Parameters

    Parameter Description
    Records-Rows The number of rows returned in this request
    Records-Start The start number of rows in this request (out of total)
    Records-Total The total number of rows available

    Search Individuals

    An example request for individuals where the name contains 'Seek'

    https://example.salesseek.net/api/organizations?search=seek
    

    Provides the the subset of indidivuals where the individual name matches the search_string.

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/individuals?search={search_string}

    Request Query Parameters

    Parameter Description
    search_string Searches for all Organizations containing this string.

    The set of information returned is reduced to maintain search performance.

    Deal API

    Deal Attributes

    The JSON encoded response looks like this.

    {
      "id": "08956ba9-ed0c-4bdd-9b8f-29efeb1d254d",
      "name": "2015 Building Works",
      "abbreviation": "PWL",
      "organization_id": "db5b165f-24aa-4c49-bbb7-a19d87a6a901",
      "funnel_id": "6cfc3549-c674-4ba6-8f02-3043d0beb174",
      "phase_name": "Contacted",
      "phase_id": "bf2005c2-bcf0-4978-8c49-af8d41bdb225",
      "owner_id": "39ee847e-3391-4d34-9114-e26fc5bbe7d2",
      "weight": 0.1,
      "status": "none",
      "value": 2225,
      "weighted_value": 222.5,
      "currency": "GBP",
      "bubble_representation_value": 2225,
      "is_favorite": false,
      "phase_last_changed": "2017-07-04T10:36:27.503306",
      "expected_close_date": "2017-02-15T00:00:00",
      "creator_id": "247f5cd0-f6b7-42d3-8b01-47b1e1941fa9",
      "tags": [],
      "comments": "",
      "created": "2016-06-23T11:40:43.770201", 
      "modified": "2017-07-04T10:36:27.407967",
      "last_modified_by_id": "247f5cd0-f6b7-42d3-8b01-47b1e1941fa9",
      "last_viewed": "2017-07-31T09:53:21.713977",
      "latest_activity_in_days": 26,
      "related_file_ids": [],
      "generated_files": [],
      "funnel": {
        "id": "6cfc3549-c674-4ba6-8f02-3043d0beb174",
        "created": "2016-06-23T10:44:18.093750",
        "modified": "2017-07-29T14:38:47.784098",
        "last_modified_by_id": "247f5cd0-f6b7-42d3-8b01-47b1e1941fa9",
        "bubble_representation": "deal_value",
        "creator_id": "247f5cd0-f6b7-42d3-8b01-47b1e1941fa9",
        "name": "Product",
        "order": 0,
        "owner_id": "247f5cd0-f6b7-42d3-8b01-47b1e1941fa9"
      },
      "phase": {
        "id": "bf2005c2-bcf0-4978-8c49-af8d41bdb225",
        "created": "2016-06-23T10:44:18.099864",
        "modified": "2017-06-07T11:47:51.508875",
        "last_modified_by_id": "247f5cd0-f6b7-42d3-8b01-47b1e1941fa9",
        "creator_id": "247f5cd0-f6b7-42d3-8b01-47b1e1941fa9",
        "funnel_id": "6cfc3549-c674-4ba6-8f02-3043d0beb174",
        "name": "Contacted",
        "hint": "Someone who has shown some interest, e.g. registered on your website. Must have email and/or phone contact details.",
        "default_weight": 0.1,
        "order": 0,
      },
      "buckets": [
        {
          "value": 2050,
          "name": "Installation",
          "id": "bf96647a-d6d5-455e-83f2-9d09e7fde25c"
        },
        {
          "value": 0,
          "name": "Services",
          "id": "299a2ae6-4d52-4dfa-b7fe-fe7a3931bb65"
        }
      ],
      "custom_fields": {
        "1e681f65-59b0-4509-a7da-a0bf34d4b9e7": "09/22/2016"
      },
      "creator": {
        ...
      },
      "owner": {
        ...
      },
      "organization": {
       ...
      }
    }
    
    Parameter Description
    id The unique identifier for this deal String
    name The user provided name for the deal String
    abbreviation 3 letter abbreviation derived from the deal name String
    organization_id ID for the assocciated Organization String
    funnel_id ID for the funnel this deal is assigned to String
    phase_name Name for the phase this deal is assigned to String
    phase_id ID for the phase this deal is assigned to String
    owner_id The ID for the SalesSeek User that has ownership of this deal String
    weight Weight value for deal. Weights are assigned to phases in the funnel. Used for forecast calculations. Double
    status Deal forecast status. (None, None Upside, Committed Downside, Committed) Enum (String)
    value Deal monetary value. Sum of all deal bucket values. Double
    weighted_value value multiplied by weight. Used in forecasating. Double
    currency Abbreviation for the currency for all revenue buckets Enum (String)
    bubble_representation_value Value used to determine deal bubble size Double
    is_favorite Set to true if this deal is marked as a favourite Boolean
    phase_last_changed Timestamp of when the deal phase was last changed. Used for UI activity colouring Timestamp (ISO 8601)
    expected_close_date User provided expected close date Timestamp (ISO 8601)
    creator_id The ID for the User that created this deal String
    tags User provided tags associated with this deal Array (Object)
    comments User provided comments associated with this deal String
    created Deal creation timestamp Timestamp (ISO 8601)
    modified Deal last modified timestamp Timestamp (ISO 8601)
    last_modified_by_id ID of the user that last modifed this deal String
    last_viewed Timestamp of the last time this deal was viewed Timestamp (ISO 8601)
    latest_activity_in_days Number of days since the last activity on deal Integer
    related_file_ids Array of related file IDs associated with this deal Array (String)
    generated_files Array of gelated file IDs associated with this deal Array (String)
    funnel Object containing detailed information about the funnel the deal is associated to Object
    funnel.id ID for the associated funnel
    funnel.created Funnel creation timestamp Timestamp (ISO 8601)
    funnel.modified Funnel last modified timestamp Timestamp (ISO 8601)
    funnel.last_modified_by_id ID of the user that last modifed this funnel String
    funnel.bubble_representation The value from deal used to generate bubble size String
    funnel.creator_id The ID for the user that created this deal String
    funnel.name The user provided name for the funnel String
    funnel.order When using multi-funnel the position this funnel should be shown Integer
    funnel.owner_id ID the the owner of this funnel String
    phase Object containing detailed information about the phase the deal is associated to Object
    phase.id ID for the associated funnel
    phase.created Phase creation timestamp Timestamp (ISO 8601)
    phase.modified Phase last modified timestamp Timestamp (ISO 8601)
    phase.last_modified_by_id ID of the user that last modifed this phase String
    phase.creator_id The ID for the user that created this phase String
    phase.funnel_id The ID for the funnel the phase is a member of String
    phase.name The user provided name for the phase String
    phase.hint User provided detail for the criteria for a deal to enter this phase String
    default_weight The default weight provided to deals when entering this phase Double
    order The position this phase should be shown in the UI Integer
    buckets Array of objects containg deal bucket values Objects
    buckets.value The value applied to this bucket Double
    buckets.name The user provided name for this bucket String
    buckets.id The unique identifier for this bucket String
    custom_field.{custom_field_id} Contains the value for the Custom Field using the custom_field_id (Mixed)
    creator Object containing detailed information about the User that created this deal Object
    owner Object containing detailed information about the User that has ownership of this deal Object
    organization Object containing detailed information about the Organization this deal is related to Object

    Get Deal

    Returns the deal matching the deal_id

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/opportunities/{deal_id}

    Parameter Description
    deal_id The ID for the deal you'd like to retrieve

    Create Deal

    Creates a new deal and then returns the newly created deal.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/opportunities/

    Update Deal

    A sample request body to change the deal phase

    {
      "phase_id": "299a2ae6-4d52-4dfa-b7fe-fe7a3931bb65"
    }
    

    Updates values of deal by deal_id. The resulting deal is returned.

    Request URL

    PATCH https://{CLIENT_ID}.salesseek.net/api/opportunities/{deal_id}

    Parameter Description
    deal_id The ID for the deal you'd like to update

    Request Body

    The only fields updated are the one passed on the request body JSON. You can pass any attribute to update.

    Delete Deal

    Deletes the deal matching the deal_id

    Request URL

    DELETE https://{CLIENT_ID}.salesseek.net/api/opportunities/{deal_id}

    Request Query Parameters

    Parameter Description
    deal_id The unique ID for the deal to be deleted.

    List Deals

    An example request to get the first 50 deals in your SalesSeek (when ordered alphabetically by name) would be:

    GET https://example.salesseek.net/api/opportunities?rows=50&start=0&order_by="name asc"
    

    The reponse header contains the following information:

    Records-Rows: 50
    Records-Start: 0
    Records-Total: 2000
    

    Returns a list of deals from your SalesSeek account.

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/opportunities

    Request Query Parameters

    Parameter Description
    rows The maximum number of deals to be returned.
    start The row number to start to retrieve data. (0 for start)
    order_by Results are ordered by the provided field name followed by &desc or &asc

    The response header contains the total number of records.

    Response Header Parameters

    Parameter Description
    Records-Rows The number of rows returned in this request
    Records-Start The start number of rows in this request (out of total)
    Records-Total The total number of rows available

    Task API

    Task Attributes

    The JSON encoded response looks like this.

    {
      "id": "b59b3772-4889-4e96-9b90-df5d0817ca44",
      "text": "#Sales Retry? Old RD Customer went to OT for Bone Daddies Ltd T/A Shackfuyu",
      "due_date": "2017-03-23T11:13:15.938419",
      "assignee_id": "1445cf43-06c5-4821-9e92-7b5810840a92",
      "owner_id": "1445cf43-06c5-4821-9e92-7b5810840a92",
      "created": "2017-03-23T11:13:15.938419",
      "creator_id": "1445cf43-06c5-4821-9e92-7b5810840a92",
      "modified": "2017-07-07T11:37:18.351486",
      "last_modified_by_id": "1445cf43-06c5-4821-9e92-7b5810840a92",
      "related_type": "organization",
      "related_id": "d10a4ea4-b329-4ffb-a786-d37987e3fc79",
      "completed": false,
      "complete_date": null,
      "related": {
        "id": "d10a4ea4-b329-4ffb-a786-d37987e3fc79",
        "name": "Bone Daddies Ltd T/A Shackfuyu",
        "type": "organizations"
      },
      "tags": [
        ...
      ],
      "creator": {
        ...
      },
      "owner": {
        ...
      },
      "assignee": {
        ...   
      },
    }
    
    Parameter Description
    id The unique identifier for this task String
    text User provided task detail text String
    due_date Timestamp for when the task is due Timestamp (ISO 8601)
    assignee_id The unique ID for the SalesSeek User that the task is currently assigned to String
    owner_id The unique ID for the SalesSeek User that has ownership of this task String
    created Task creation timestamp Timestamp (ISO 8601)
    creator_id The unique ID for the SalesSeek User that created this task String
    modified Task last modified timestamp Timestamp (ISO 8601)
    last_modified_by_id The unique ID for the SalesSeek User that last modified this task String
    related_type The type of record in SalesSeek that the task is related to (organization, individual, deal) Enum
    related_id The ID for the record that the task is reated to String
    completed Set to true if the task is completed Boolean
    complete_date Timestamp for when the task was completed Timestamp (ISO 8601)
    related Object containing detailed information about the record the task is related to Object
    related.id The ID for the record that the task is related to String
    related.name The name of the record that the task is related to String
    related.type The type of record in SalesSeek that the task is related to (organization, individual, deal) Enum
    tags User provided tags associated with this task Array (Object)
    creator Object containing detailed information about the User that created this task Object
    owner Object containing detailed information about the User that has ownership of this task Object
    assignee Object containing detailed information about the User this task is assigned to Object

    Get Task

    Returns the task matching the task_id

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/tasks/{task_id}

    Parameter Description
    task_id The ID for the task you'd like to retrieve String

    Create Task

    An example request body to create a new task that is associated to an opportunity and has a due date in 1 week.

    {
      "assignee_id": "1445cf43-06c5-4821-9e92-7b5810840a92",
      "due_date": "Jul 26, 2017 11:00",
      "related_id": "5f592311-4e8c-400d-b535-d4738adb7e93",
      "related_type": "opportunity",
      "text": "Follow up in one week",
      "tags": []
    }
    

    Creates a new task and then returns the newly created task.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/tasks

    Update Task

    A example request body to change the task due date would be:

    {
      "due_date": "Jul 28, 2017 11:00",
    }
    

    Updates values of task by task_id. The resulting task is returned.

    Request URL

    PATCH https://{CLIENT_ID}.salesseek.net/api/tasks/{task_id}

    Parameter Description
    task_id The ID for the task you'd like to update String

    Delete Task

    Deletes the task matching the task_id

    Request URL

    DELETE https://{CLIENT_ID}.salesseek.net/api/tasks/{task_id}

    Request Query Parameters

    Parameter Description
    task_id The unique ID for the task to be deleted.

    List Tasks

    An example request to get the first 50 tasks in your SalesSeek account (when ordered by due date) would be:

    GET https://example.salesseek.net/api/tasks?rows=50&start=0&order_by=due_date%20asc
    

    The reponse header contains the following information:

    Records-Rows: 50
    Records-Start: 0
    Records-Total: 2000
    

    Returns a list of tasks from your SalesSeek account.

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/tasks

    Request Query Parameters

    Parameter Description
    rows The maximum number of organizations to be returned.
    start The row number to start to retrieve data. (0 for start)
    order_by Results are ordered by the provided field name followed by %20desc or %20asc

    The response header contain the total number of records.

    Response Header Parameters

    Parameter Description
    Records-Rows The number of rows returned in this request
    Records-Start The start number of rows in this request (out of total)
    Records-Total The total number of rows available

    Search Tasks

    An example request for tasks where the name contains 'example'

    https://example.salesseek.net/api/tasks?search=test
    

    Provides the the subset of tasks where the tasks name matches the search_string.

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/tasks?search={search_string}

    Request Query Parameters

    Parameter Description
    search_string Searches for all Organizations containing this string.

    The set of information returned is reduced to maintain search performance.

    Filter API

    Filters allow you to segment your records within SalesSeek. You can use any field, including custom fields, as a value to filter against.

    Filters are designed to be applied to Groups to allow you to view records.

    The SalesSeek API does not support updating, deleting, or listing of filters. To update a filter, create a new filter with the amended values.

    Filters that are not associated with a Groups will be cleaned up periodically. To ensure your filter does not get deleted ensure that it is assigned to a Groups .

    Filter Attributes

    The JSON encoded response for filtering individual records owned by 'Example User' that have opened either the 'Free Webinar' or 'Free Trial' email.

    {
        "id": "ef7e7b1c-a007-4eeb-aed8-c54657fddd8f",
      "filter_type": "individuals",
      "rules": [
        [
          {
            "field": "owner_id",
            "operator": "equal",
            "values": {
              "name": "Example Users",
              "id": "a938196a-152d-40f3-ab3d-804985143a4b"
            }
          }
        ],
        [
          {
            "field": "campaign_stats_open",
            "operator": "any",
            "values": {
              "campaign": {
                "name": "Free Webinar",
                "id": "41c4f28f-4e07-4cce-aaa8-0e2afac82577"
              }
            }
          },
          {
            "field": "campaign_stats_open",
            "operator": "any",
            "values": {
              "campaign": {
                "name": "Free Trial",
                "id": "774ed7f4-5c72-465a-82a2-5c47cf0db863"
              }
            }
          }
        ]
      ]
    }
    
    Parameter Description
    id The unique identifier for this filter String
    filter_type The type of records to be filtered (indidivuals, opportunities, organizations, tasks) Enum (String)
    rules Array containing rules used for this filter Array
    rules[x].field The name of the field that is used in this filter String
    rules[x].operator The operator used in this filter String
    rules[x].values Object containing the values used to apply to this filter Object
    rules[x].values.name Name of the values to be applied to this filter Object
    rules[x].values.id ID of the values to be applied to this filter Object

    Filters can use AND and OR rules. AND rules are determined by the rule objects being in separate arrays in the rules array. OR values are multiple objects in the same array.

    The provided example would have the following appearance in the SalesSeek app.

    Filter Example

    Due to the fact that the SalesSeek app uses the same API, you can inspect the XHR calls that the application performs. This allows you to create complex filters via the UI and replicate the API calls in your own application.

    Get Filter

    Returns the filter matching the filter_id

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/{record_type}/filters/{filter_id}

    Request Query Parameters

    Parameter Description
    record_type The record type that the filter applies to (individuals, organizations, opportunities, tasks)
    filter_id The ID for the filter you'd like to retrieve

    Create Filter

    Creates a new filter and then returns the newly created filter.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/{record_type}/filters/

    Group API

    The Group API returns only the metadata for each group.

    The Group API does not return the records associated with each group. To get the associated records use the get the filter_id from this endpoint and use this value in the Group Pages API.

    The Group API funcionality differs depending on if the group is a smart or a static group. For an explanation of the different types of groups see the help center article.

    Group Attributes

    A sample smart group response would look like this.

    {
        "id": "9c254f26-2217-4d21-b7b5-49591fde0a2f",
        "name": "πŸ‡¬πŸ‡§ UK Users",
        "group_type": "smart",
        "element_type": "individuals",
        "locked": false,
        "comments": "All current users of the SalesSeek system. ",
        "mailing_list": false,
        "created": "2017-06-13T16:01:07.192856",
        "modified": "2017-06-13T17:46:27.194513",
        "owner_id": "69c5bc2a-c8e5-4d11-a102-6ec0fb410d1b",
        "creator_id": "69c5bc2a-c8e5-4d11-a102-6ec0fb410d1b",
        "last_modified_by_id": "69c5bc2a-c8e5-4d11-a102-6ec0fb410d1b",
        "owner": {
            ...
        },
        "creator": {
            ...
        },
        "filter_id": "9d60827c-89da-4e31-8b62-0258f3adbd59",
        "filter": {
            ...
        },
        "columns": [
        "photo_url",
        "first_name",
        "last_name",
        "organization.name",
        "email",
        "phone",
        "sortable_name"
      ],
        "order_by": null,
        "cost_basis": "total",
        "cost": 0,
        "target": null,
    }
    
    Parameter Description
    id The unique identifier for this group String
    name User provided name for the group String
    group_type The type of group (static, smart) Enum (String)
    element_type The type of record this group can contain (individuals, organizations, opportunities, tasks)Enum (String)
    locked Set to true if editing this group has been locked (usually the result of the group being used in an automation) boolean
    comments User provided comments associated with the group String
    mailing_list Set to true if this group is a mailing list (only applicable on static groups) boolean
    created Group creation timestamp Timestamp (ISO 8601)
    modified Group last modified timestamp Timestamp (ISO 8601)
    owner_id ID for the User that has ownership for this group String
    creator_id ID for the User that created this group String
    last_modified_by_id ID for the User that last modified the group String
    creator Object containing detailed information about the User that created this group Object
    owner Object containing detailed information about the User that owns this group Object
    filter_id The ID for the group filter String
    filter Object containing detailed information about the group filter Object
    columns Array of column names to be shown in this group Object
    creator Object containing detailed information about the User that created this group Object
    display_options Object containing display options for this group Object
    display_options.sort.direction Set to true if sort order is ascending, set to false for descending Boolean
    display_options.sort.field The name of the column to apply the sort ordering to String
    display_options.show_as Set to either table or list depending on the chosen default view for this group String

    Get Group

    Returns the group matching the group_id

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/groups/{group_id}

    Request Query Parameters

    Parameter Description
    group_id The ID for the group you'd like to retrieve

    Create Group

    An example request body to create a smart group called 'πŸ‡ΊπŸ‡Έ US Customers' would be:

    {
        "name": "πŸ‡ΊπŸ‡Έ US Customers",
        "group_type": "smart",
        "element_type": "individuals",
    }
    

    When the group is created it will contain all individual records. You need to apply a filter to this group to filter to customers from the US.

    By default group owner will be assigned to the user creating the group. You can pass a owner object to set the group owner to a different user.

    Creates a new group and then returns the newly created group.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/{record_type}/filters/

    Request Body Parameters

    Parameter Description
    name Provided name for the group String
    group_type The type of group (static, smart) Enum (String)
    element_type The type of record this group can contain (individuals, organizations, opportunities, tasks) Enum (String)

    Update Group

    An example request body to change the group owner would be:

    {
        "owner_id": "40575ca1-381c-4542-a556-e3c2d81ef67e"
    }
    

    An example request body to set a filter to smart group would be:

    {
        "filter_id": "0c8b0614-db0d-4b90-ace2-b2eabea66788"
    }
    

    Updates values of group by group_id. The resulting group is returned.

    Request URL

    PATCH https://{CLIENT_ID}.salesseek.net/api/groups/{group_id}

    Parameter Description
    group_id The ID for the group you'd like to update String

    Request Body

    The only fields updated are the one passed on the request body JSON. You can pass any attribute to update.

    Delete Group

    Deletes the group matching the group_id

    Request URL

    DELETE https://{CLIENT_ID}.salesseek.net/api/groups/{group_id}

    Request Query Parameters

    Parameter Description
    group_id The unique ID for the group to be deleted.

    List Groups

    An example request to get all individual groups would be:

    GET https://example.salesseek.net/api/groups?start=0&rows=-1&element_type=individuals
    

    Returns a list of groups from your SalesSeek account.

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/groups

    Request Query Parameters

    Parameter Description
    element_type Filter by groups containing certain record types (organizations, opportunities, individuals).
    rows The maximum number of organizations to be returned
    start The row number to start to retrieve data. (0 for start)
    order_by Results are ordered by the provided field name followed by &desc or &asc

    If element_type is not provided individual and opportunity groups are returned.

    Add Record to Static Group

    An example request to add a record to a group would be.

    PUT https://example.salesseek.net/api/groups/13663429-0f49-4e83-836c-7ecd6d58adf5/items/4bb55a82-ee66-4752-bc47-ce7edd05ddb1
    

    Adds a record to a static group.

    PUT https://{CLIENT_ID}.salesseek.net/api/groups/{group_id}/items/{record_id}

    Request Query Parameters

    Parameter Description
    group_id The unique ID for the group to be deleted
    record_id The ID for the record to be added to this group

    Records can only be added to static groups. Filters should be applied to smart groups to add records to smart groups.

    Group Page API

    The Group Pages API should be used in conjunction with the Group API. The Group API contains the metadata for each group. The Group Pages API is used to return records associated with a group in a paginated form.

    Group Page Attributes

    A sample Group Pages response on an organization group would look like:

    {
      "columns": [
        "photo_url",
        "first_name",
        "last_name",
        "organization.name",
        "email",
        "phone"
      ],
      "rows": [
        {
          "id": "dc1aba21-37ad-4feb-8dca-3d7ce4ec29fe",
          "cells": [
            "",
            "Anna",
            "Walker",
            "Woking Leal",
            [
              {
                "name": "Work",
                "value": "dangerdanger@mailinator.com"
              }
            ],
            []
          ]
        },
        {
          "id": "a303df0a-8caf-499c-83d8-e8455a5978b9",
          "cells": [
            "",
            "David",
            "Romero",
            "Linkbuzz",
            [
              {
                "name": "Work",
                "value": "david.romero@suremail.info"
              }
            ],
            [
              {
                "name": "Work",
                "value": "6-(186)598-3830"
              }
            ]
          ]
        }
      ],
      "order_by": [
        "full_name",
        "asc"
      ],
      "totals": null
    }
    
    Parameter Description
    columns Array containing the column names in the returned data Array (String)
    rows Array containing the rows of data returned as objects Array (Object)
    order_by Array of the values the returned data is ordered by Array (String)
    totals Object containing the total values for this group (only available on Deal groups, null for all other groups) Object
    totals.default_value Grand total for all deals in this group (shown at bottom of group, when in table view) Double
    totals.comitted_value Total for all deals in group that have comitted status Double
    totals.closed_value Total for all deals in group that have closed status Double

    Get Group Page

    A sample request for a maximum of 50 records from a group could look like:

    GET https://example.salesseek.net/api/group_pages?item_type=individuals&group_id=5f1e7c37-2a27-4dab-b834-7f0054303555&rows=50&columns=photo_url,first_name,last_name,organization.name,email,phone,source&order_by=full_name%20asc
    

    Returns the requested number of records from group_id

    GET https://https://{CLIENT_ID}.salesseek.net/api/group_pages

    Request Query Parameters

    Parameter Description
    item_type The type of record to return in this group page (individuals, organizations, opportunities, tasks)
    group_id The ID for the group to retrieve records from
    rows The maximum number of organizations to be returned
    start The row number to start to retrieve data. (0 for start)
    order_by Results are ordered by the provided field name followed by &desc or &asc

    Campaign API

    Campaign Attributes

    The JSON encoded response looks like this.

    {
      "id": "0a6a5701-99c9-4a80-ad78-c5g05c9497bc",
      "name": "Free Webinar today at 3pm",
      "status": "draft",
      "subject": "Free Webinar today at 3pm",
      "campaign_type": "campaign",
      "to_group_id": "99c90-a6a5701-4a80-ad78-c5g05c9497bc",
      "to_group": null,
      "sent": null,
      "used_in_automations": false,
      "used_in_live_automations": null,
      "include_signature": true,
      "campaign_schedule_id": "a1053ecf-ef72-4f5f-8b74-56ce1b7b401e",
      "campaign_schedule": {
        "id": "a1053ecf-ef72-4f5f-8b74-56ce1b7b401e",
        "timezone": "UTC",
        "utc_offset": "-60",
        "when": "2017-09-29T12:00:00",
        "when_utc": "2017-09-29T11:00:00"
      },
      "track": true,
      "owner_id": "1445cf43-06c5-4821-9e92-7b5810840a92",
      "creator_id": "a4c510ac-5f3b-4a2a-b3bd-ef0dc1ae1680"
      "last_modified_by_id": "a4c510ac-5f3b-4a2a-b3bd-ef0dc1ae1680",
      "created": "2017-05-23T08:56:14.036080",
      "modified": "2017-07-31T11:13:07.689772",
      "from_user_id": "a4c510ac-5f3b-4a2a-b3bd-ef0dc1ae1680",
      "from_user": {
        ...
      },
      "creator": {
        ...
      },
      "owner": {
        ...
      },
      "email_status_stats": {
        "sent": 0,
        "queued": 0,
        "in_progress": 0,
        "failed": 0,
        "cancelled": 0
      },
      "email_event_stats": {
        "undelivered_rate": 4,
        "unsubscribed_rate": 0,
        "click": 74,
        "queued": 0,
        "delivered": 15536,
        "soft_bounce": 460,
        "reject": 18,
        "soft_bounce_rate": 2,
        "spam": 627,
        "spam_rate": 3,
        "send": 16347,
        "unsubscribed_list": 0,
        "unsubscribed_all_rate": 0,
        "bounce_rate": 4,
        "click_rate": 0,
        "open_rate": 10,
        "hard_bounce": 333,
        "delivered_rate": 95,
        "send_rate": 0,
        "hard_bounce_rate": 2,
        "open": 1678,
        "undelivered": 811,
        "unsubscribed_list_rate": 0,
        "bounce": 793,
        "unsubscribed": 136,
        "reject_rate": 0,
        "unsubscribed_all": 136
      },
      "content": "<!DOCTYPE html><h1>Example HTML Email</h1></html>",
    
    }
    
    
    Parameter Description
    id The unique identifier for this campaign String
    name The user provided title for the campaign String
    status Current status of the campaign (draft, ready, scheduled, sent) Enum (String)
    subject The subject line for the campaign String
    campaign_type The type of the campaign (direct, campaign) Enum (String)
    to_group_id The ID for the group the campaign is to be sent to String
    to_group Object containing detailed information about the group associated with this campaign Object
    sent Timestamp for when the campaign was sent Timestamp (ISO 8601)
    used_in_automations Set to true if this campaign is currently accociated with an automation Boolean
    used_in_live_automations Set to true if this campaign is currently accociated with an automation which is currently set to live Boolean
    include_signature Set to true if the signature for the user this campaign will be sent from will be appended to the email (direct emails only) Boolean
    campaign_schedule_id Unique identifier for the campaign schedule String
    campaign_schedule Object containing detailed information about the schedule assigned to this campaign Object
    campaign_schedule.id Unique identifier for the campaign schedule String
    campaign_schedule.timezone Three character representation of the timezone for this schedule. String
    campaign_schedule.utc_offset The UTC offset from schedule in minutes Integer
    campaign_schedule.when Timestamp for when this campaign should be sent Timestamp (ISO 8601)
    campaign_schedule.when_utc Timestamp for when this campaign should be sent in UTC Timestamp (ISO 8601)
    track Set to true if SalesSeek should track statistics on this campaign Boolean
    owner_id The ID for the User that has ownership over this campaign String
    creator_id The ID for the User that created this campaign String
    last_modified_by_id The ID for the SalesSeek User that last modified this campaign String
    created Campaign creation timestamp Timestamp (ISO 8601)
    modified Campaign last modified timestamp Timestamp (ISO 8601)
    from_user_id ID of the User the campaign will be sent from String
    from_user Object containing detailed information about the User the campaign will be sent from Object
    creator Object containing detailed information about the User that created this campaign Object
    owner Object containing detailed information about the User that owns this campaign Object
    email_status_stats Object containing email status statistics Object
    email_status_stats.sent Number of sent emails in campaign Integer
    email_status_stats.queued Number of emails queued in campaign Integer
    email_status_stats.in_progress Number of emails in progress in campaign Integer
    email_status_stats.failed Number of emails failed in campaign Integer
    email_status_stats.cancelled Number of emails queued in campaign Integer
    email_event_stats Object containing email event statistics Object
    email_event_stats.delivered Number of delivered emails in campaign Integer
    email_event_stats.open Number of delivered opened in campaign Integer
    email_event_stats.undelivered_rate Rate of un-delivered emails in campaign Integer
    email_event_stats.queued Number of emails queued in campaign Integer
    email_event_stats.click Number of clicked emails in campaign Integer
    email_event_stats.click_rate Rate of clicked emails in campaign Integer
    email_event_stats.hard_bounce_rate Rate of hard bounces in campaign Integer
    email_event_stats.delivered_rate Rate of delivered emails in campaign Integer
    email_event_stats.soft_bounce_rate Rate of soft bounces in campaign Integer
    email_event_stats.bounce_rate Rate of bounces in campaign Integer
    email_event_stats.hard_bounce Rate of hard bounces in campaign Integer
    email_event_stats.send Number of emails sent in campaign Integer
    email_event_stats.unsubscribed Number of unsubscribes from this campaign Integer
    email_event_stats.bounce Number of bounces in campaign Integer
    email_event_stats.spam Number of emails marked as spam in campaign Integer
    email_event_stats.open_rate Rate of emails opened in campaign Integer
    email_event_stats.unsubscribed_all_rate Rate of unsubscribes from all email campaigns Integer
    email_event_stats.spam Rate of emails marked as spam in this campaign Integer
    email_event_stats.reject Number of emails rejected in this campaign Integer
    email_event_stats.send_rate Rate of emails sent in this campaign Integer
    email_event_stats.undelivered Rate of emails not delivered in this campaign Integer
    email_event_stats.soft_bounce Number of soft bounces in this campaign Integer
    email_event_stats.unsubscribed_rate Rate of unsubscribes in this campaign Integer
    email_event_stats.reject_rate Rate of rejections in this campaign Integer
    email_event_stats.unsubscribed_all Number of individuals who have unsubscibed from all email campaigns Int
    content HTML content for this email String

    Get Campaign

    Returns the unique organization matching the campaign_id

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/campaigns/{campaign_id}

    Parameter Description
    campaign_id The ID for the campaign you'd like to retrieve String

    Create Campaign

    Creates a new campaign and then returns the newly created campaign.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/campaigns

    Update Campaign

    A sample request body to update the campaign subject.

    {
      "subject": "Free Webinar @5pm"
    }
    

    Updates values of a campaign by campaign_id. The resulting campaign is returned.

    Request URL

    PATCH https://{CLIENT_ID}.salesseek.net/api/campaigns/{campaign_id}

    Parameter Description
    campaign_id The ID for the campaign you'd like to update String

    Request Body

    The only fields updated are the one passed on the request body JSON. You can pass any attribute to update.

    Delete Campaign

    Deletes the campaign matching the campaign_id

    Request URL

    DELETE https://{CLIENT_ID}.salesseek.net/api/campaigns/{campaign_id}

    Request Query Parameters

    Parameter Description
    campaign_id The unique ID for the campaign to be deleted.

    List Campaigns

    An example request to get the first 50 unsent campaigns in your SalesSeek account (when ordered by modfied date) would be:

    GET https://example.salesseek.net/api/campaigns?rows=50&start=0&order_by=modified%20desc&status=ready,draft
    

    The reponse header contains the following information:

    Records-Rows: 50
    Records-Start: 0
    Records-Total: 2000
    

    Returns a list of campaigns from your SalesSeek account.

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/campaigns

    Request Query Parameters

    Parameter Description
    rows The maximum number of organizations to be returned.
    start The row number to start to retrieve data. (0 for start)
    order_by Results are ordered by the provided field name followed by &desc or &asc

    The response header contain the total number of records.

    Response Header Parameters

    Parameter Description
    Records-Rows The number of rows returned in this request
    Records-Start The start number of rows in this request (out of total)
    Records-Total The total number of rows available

    Send Campaign Test

    An example request to send a test of a campaign to example@salesseek.com would be made to:

    POST https://{CLIENT_ID}.salesseek.net/api/campaigns?test=example@salesseek.com
    

    An example request body would be:

    {
      "campaign_type": "direct",
      "content": "<!DOCTYPE html>\n<html>\n<head>\n</head>\n<body>\n<p>Example Email</p>\n</body>\n</html>",
      "status": "draft",
      "from_user": {
        "id": "a938196a-1d2d-40f3-ab3d-804985143a4b",
        "name": "SalesSeek Example",
        "email_address": "example@salesseek.com",
        "email_signature": "<h2>Email Signature</h2>"
      },
      "include_signature": true,
      "track": true,
      "name": "Example Email",
      "subject": "Example Email",
      "to_group": {
        "id": "68b2647d-bf9d-4f6f-9cbc-0d1f21687ae0",
        "name": "Email Group"
      }
    }
    

    This enpoint will respond with null.

    Sends a test email of the campaign content to chosen SalesSeek users.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/campaigns?test={user_email}

    Request Query Parameters

    Parameter Description
    user_email The maximum number of organizations to be returned.

    Request Body Parameters

    Parameter Description
    campaign_type The type of the campaign (direct, campaign) Enum (String)
    content HTML content for this email String
    status Current status of the campaign (draft, ready, scheduled, sent) Enum (String)
    from_user Object containing detailed information about the User the campaign will be sent from Object
    from_user.id ID of the SalesSeek User the email will be sent from String
    from_user.name Name of the SalesSeek User the email will be sent from String
    from_user.email_address Email address of the SalesSeek User the email will be sent from String
    from_user.email_signature Signature for the SalesSeek User the email will be sent from String
    include_signature Set to true if the signature for the User this campaign will be sent from will be appended to the email (direct emails only) Boolean
    track Set to true if SalesSeek should track statistics on this campaign Boolean
    name The user provided title for the campaign String
    subject The subject line for the campaign String
    to_group Object containing detailed information about the group associated with this campaign Object
    to_group.id ID for the group the campaign will be sent to String
    to_group.name Name for the group the campaign will be sent to String

    Values for the request body can be obtained by performing a GET Request on the campaign ID

    Set Campaign Live

    Sets a campaign to live and ready for sending.

    POST https://salesseek.salesseek.net/api/campaigns?send

    Request Query Parameters

    (none)

    Request Body Parameters

    Parameter Description
    campaign_type The type of the campaign (direct, campaign) Enum (String)
    content HTML content for this email String
    status Current status of the campaign (draft, ready, scheduled, sent) Enum (String)
    from_user Object containing detailed information about the User the campaign will be sent from Object
    from_user.id ID of the SalesSeek User the email will be sent from String
    from_user.name Name of the SalesSeek User the email will be sent from String
    from_user.email_address Email address of the SalesSeek User the email will be sent from String
    from_user.email_signature Signature for the SalesSeek User the email will be sent from String
    include_signature Set to true if the signature for the User this campaign will be sent from will be appended to the email (direct emails only) Boolean
    track Set to true if SalesSeek should track statistics on this campaign Boolean
    name The user provided title for the campaign String
    subject The subject line for the campaign String
    to_group Object containing detailed information about the group associated with this campaign Object
    to_group.id ID for the group the campaign will be sent to String
    to_group.name Name for the group the campaign will be sent to String

    Values for the request body can be obtained by performing a GET Request on the campaign ID

    Activity API

    Activity Attributes

    An example response body for an activity note would look like this:

    {
        "id": "ef59f293-9838-4043-b0f4-9b0a6f467d73",
        "activity_type": "note",
        "target_type": "individuals",
        "owner_id": "8da68e42-baef-42b2-9c72-4a00b5e20082",
        "owner": {
            ...
        },
        "creator_id": "8da68e42-baef-42b2-9c72-4a00b5e20082",
         "creator": {
            ...
        },
        "tags": [
            ...
        ],
        "created": "2017-08-03T10:42:41.843271",
        "modified": "2017-08-03T10:42:41.843271",
        "last_modified_by_id": "8da68e42-baef-42b2-9c72-4a00b5e20082",
        "individual_id": "079f2797-df8d-4141-b10b-7c26553132e9",
        "individual_name": "Chelsea Wallace",
        "opportunity_id": null,
        "opportunity_name": null,
        "organization_id": null,
        "organization_name": null,
        "note": "<p>Agreed payment plan</p>",
        "params": null,
        "target_date": null,
        "communication": null,
        "communication_id": null,
        "real_created": "2017-08-03T10:42:41.843271",
        "user_created": "2017-08-03T10:42:41.843271",
        "target_is_parent": true,   
    }
    

    An example response body for a sent direct email campaign to an individual would look like:

    {
        "id": "a3365acc-831c-45ec-b83d-f5d2b31dbc24",
        "activity_type": "automation:archive:mailshot_sent",
        "target_type": "individuals",
        "owner_id": "69c5bc2a-c8e5-4d11-a102-6ec0fb410d1b",
        "owner": {
          ...
        },
        "creator_id": "69c5bc2a-c8e5-4d11-a102-6ec0fb410d1b",
        "creator": {
          ...
        },
        "tags": [
          ...
        ],
        "created": "2017-08-14T12:10:59.048847",
        "modified": "2017-08-14T12:10:59.048847",
        "last_modified_by_id": "69c5bc2a-c8e5-4d11-a102-6ec0fb410d1b",
        "individual_id": "285ae016-58d4-4dbc-bff3-339c2b4540ff",
        "individual_name": "Gregory John",
        "opportunity_id": null,
        "opportunity_name": null,
        "organization_id": null,
        "organization_name": null,
        "note": "SalesSeek sent Welcome Email to Gregory John",
        "params": {
            "mailshot_id": "91c2c7f6-71d2-4d57-909d-66bc6a978023",
            "campaign_id": "91c2c7f6-71d2-4d57-909d-66bc6a978023",
            "mailshot_name": "Welcome Email",
            "campaign_type": "direct",
            "campaign_name": "Welcome Email"
        },
        "target_date": null,
        "communication": null,
        "communication_id": null,
        "real_created": "2017-08-14T12:10:59.048847",
        "user_created": "2017-08-14T12:10:59.048847",
        "target_is_parent": true
    }
    
    

    An example response body for a deal phase move would look like:

    {
        "id": "a300284d-b708-4d50-8d42-e2e8ab4cceeb",
        "activity_type": "auto:opportunity_movement",
        "target_type": "opportunities",
        "owner_id": "69c5bc2a-c8e5-4d11-a102-6ec0fb410d1b",
        "owner": {
          ...
        },
        "creator_id": "69c5bc2a-c8e5-4d11-a102-6ec0fb410d1b",
        "creator": {
          ...
        },
        "tags": [
          ...
        ],
        "created": "2017-08-14T13:27:23.254368",
        "modified": "2017-08-14T13:27:23.254368",
        "last_modified_by_id": "69c5bc2a-c8e5-4d11-a102-6ec0fb410d1b",
        "individual_id": null,
        "individual_name": null,
        "opportunity_id": "81e96bca-abdc-4753-8763-fc642afb3c99",
        "opportunity_name": "Aptui",
        "organization_id": null,
        "organization_name": null,
        "note": "SalesSeek moved Aptui from Engaged to Won",
        "params": {
            "from_funnel_id": "7d40c1e6-1e66-4dac-bd4b-0e29184c6dcd",
            "to_id": "c8a2a4c1-420b-4d7e-99d9-3f54eb503f2b",
            "to": "Lost",
            "from": "Engaged",
            "from_funnel": "Online",
            "who": "Dale Goulding",
            "from_id": "c4329a4a-44fe-4948-9c90-46a589266643"
        },
        "target_date": null,
        "communication": null,
        "communication_id": null,
        "real_created": "2017-08-14T13:27:23.254368",
        "user_created": "2017-08-14T13:27:23.254368",
        "target_is_parent": true,
    }
    
    Parameter Description
    id The unique identifier for this activity String
    activity_type The type of activity String
    target_type The record type the activity relates to (organization, opportunity, individual) Enum (string)
    owner_id The ID for the SalesSeek User that has ownership of this activity String
    owner Object containing detailed information about the User that owns this activity Object
    creator_id The unique ID for the SalesSeek User that created this activity String
    creator Object containing detailed information about the User that created this activity Object
    tags Array of tags associated with this activity Array
    created Activity creation timestamp Timestamp (ISO 8601)
    modified Activity last modified timestamp Timestamp (ISO 8601)
    last_modified_by_id The unique ID for the SalesSeek User that last modified this activity String
    individual_id The ID for the individual record this activity is associated to - null if not associated with an individual String
    individual_name The name of the individual record that this activity is associated to - null if not associated with an individual String
    opportunity_id The ID for the deal record this activity is associated to - null if not associated with a deal String
    opportunity_name The name of the deal record that this activity is associated to - null if not associated with a deal String
    organization_id The ID for the organization record this activity is associated to - null if not associated with an organization String
    organization_name The name of the organization record that this activity is associated to - null if not associated with an organization String
    note The activity note contents in HTML - null if activity not a note String
    params Object containing detailed informaiton about the activity - null if activity is not a phase move. Object
    params.to_id ID for the phase that the deal has been moved to (shown if activity was a phase move) String
    params.to Name for the phase that the deal has been moved to (shown if activity was a phase move) String
    params.from_id ID for the phase that the deal was moved from (shown if activity was a phase move) String
    params.from Name for the phase that the deal was moved from (shown if activity was a phase move) String
    params.to_funnel_id The ID for the funnel that the deal was moved to (shown if activity was a phase move) String
    params.to_funnel The name for the funnel that the deal was moved to (shown if activity was a phase move) String
    params.from_funnel_id The ID for the funnel that the deal was moved from (shown if activity was a phase move) String
    params.from_funnel The name for the funnel that the deal was moved from (shown if activity was a phase move) String
    params.who Name of the User who performed the activity (shown if activity was a phase move) String
    params.campaign_id The ID for the campaign where the activity originates (shown if activity was related to a campaign) String
    params.campaign_name The name for the campaign where the activity originates (shown if activity was related to a campaign) String
    params.campaign_type The type of email campaign (direct, campaign) (shown if activity was related to a campaign) String
    params.url The URL that was clicked in the campaign email (shown if activity was related to a campaign link being clicked) String
    params.subject The email subject (shown if activity was an archived email) String
    params.completed_by The name of the User that completed the task (shown if activity was a completed task) String
    params.description Descripion of completed tasks (shown if activity was a comlpleted task) String
    params.subject The email subject for archived emails String
    target_date Timestamp for the activity target date Timestamp (ISO 8601)
    real_created Timestamp for when the activity was created in the system Timestamp (ISO 8601)
    user_created Timestamp for when a User has said the activity was created (if user has overridden the time) Timestamp (ISO 8601)

    Activity Types

    Types Description
    auto:organization_import An organization was imported
    auto:individual_import An individual was imported
    auto:opportunity_import A deal was imported
    auto:organization_creation An organization was created
    auto:individual_creation An individual was created
    auto:opportunity_creation A deal was created
    archive:email An email was archived
    archive:mailshot_sent A campaign was sent
    archive:mailshot_opened A campaign was opened
    automation:archive:mailshot_url_clicked A link in a campaign was clicked
    automation:archive:mailshot_sent A campaign was sent
    auto:call A call was logged
    task:completed A task was completed

    Get Activity

    Returns the unique organization matching the activity_id

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/activities/{activity_id}

    Request Query Parameters

    Parameter Description
    activity_id The ID for the activity you'd like to retrieve String

    Create Activity

    A sample request body to add an activity note would look like:

    {
      "note": "<p>Called today and agreed on deal terms.</p>",
      "created": null,
      "target_date": null,
      "activity_type": "note",
      "item_type": "opportunities",
      "item_id": "0d98b2fa-c4c8-4d56-9cda-17b62b198f4f",
      "tags": []
    }
    

    Creates a new activity record and then returns the newly created activity.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/activities

    Update Activity

    A sample request body to change the activity note text would be:

    {
      "note": "<p>Called yesterday and agreed on deal terms.</p>",
    }
    

    Updates values of activity by activity_id. The resulting activity is returned.

    Request URL

    PATCH https://{CLIENT_ID}.salesseek.net/api/activities/{activity_id}

    Parameter Description
    activity_id The ID for the activity you'd like to update String

    Request Body

    The only fields updated are the one passed on the request body JSON. You can pass any attribute to update.

    Delete Activity

    Deletes the activity matching the activity_id

    Request URL

    DELETE https://{CLIENT_ID}.salesseek.net/api/activities/{activity_id}

    Request Query Parameters

    Parameter Description
    activity_id The unique ID for the organization to be deleted.

    List Activities

    An example request to get the first 50 activites for a particular opportunity, ordered by creation date descending, with all activity types returned.

    GET https://example.salesseek.net/api/activities?start=0&rows=50&order_by=created%20desc&notes=true&communications=true&contact_updates=true&deals=true&campaign_emails=true&automation_emails=true&include_ind_related=true&include_org_related=true&include_deal_related=true&item_type=opportunities&item_id=0d98b2fa-c4c8-4d56-9cda-17b62b198f4f
    

    The reponse header contains the following information:

    Records-Rows: 50
    Records-Start: 0
    Records-Total: 2000
    

    Returns a list of activities.

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/activities

    Request Query Parameters

    Parameter Description
    rows The maximum number of organizations to be returned.
    start The row number to start to retrieve data. (0 for start)
    order_by Results are ordered by the provided field name followed by &desc or &asc
    notes Set to true to request activity notes (true or false)
    communications Set to true to request all communication activity (true or false)
    contact_updates Set to true to request all contact update activity (true or false)
    deals Set to true to request all deal activity (true or false)
    campaign_emails Set to true to request all campaign email activity (true or false)
    automation_emails Set to true to request all automation email activity (true or false)
    include_ind_related Set to true to request all activities from related individuals (true or false)
    include_org_related Set to true to request all activities from related organizations (true or false)
    include_deal_related Set to true to request all activities from related deals (true or false)
    item_type Set type of record activities to get related activities from (opportunities, organizations, indviduals)
    item_id ID for the recrod to get related activities from

    Tag API

    Tag Attributes

    An example response body for a tag would look like this:

    {
      "id": "6e9f2fa6-d376-4313-aaea-13dfde3856a4",
      "name": "Renewal",
        "creator_id": "8baadb17-d37e-47f7-b116-0f15c06f297e",
        "created": "2017-05-11T11:32:12.366298",
        "modified": "2017-05-11T11:32:12.366298",
        "last_modified_by_id": "8baadb17-d37e-47f7-b116-0f15c06f297e"
      }
    
    Parameter Description
    id The unique identifier for this tag String
    name The name for this tag String
    creator_id The ID for the User that created the tag String
    created Tag creation timestamp Timestamp (ISO 8601)
    modified Tag last modified timestamp Timestamp (ISO 8601)
    last_modified_by_id The unique ID for the SalesSeek User that last modified this tag String

    Create Tag

    An example request body for creating a new tag would look like this:

    {
        "name": "Renewal"
    }
    

    Creates a new tag and then returns the newly created Tag ID.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/tags

    Update Tag

    Updates values of organization by tag_id. The resulting tag is returned.

    Request URL

    PATCH https://{CLIENT_ID}.salesseek.net/api/tags/{tag_id}

    Parameter Description
    id The ID for the organization you'd like to update String

    Request Body

    The only value that can be updated for tags via the API is the Tag name. Pass the updated name as a JSON object.

    Delete Tag

    Deletes the tag matching the tag_id

    Request URL

    DELETE https://{CLIENT_ID}.salesseek.net/api/tags/{tag_id}

    Request Query Parameters

    Parameter Description
    tag_id The ID for the tag to be deleted.

    List Tags

    An example request to get all tags in your SalesSeek account (when ordered alphabetically by modified date) would be:

    https://example.salesseek.net/api/tags?start=0&rows=-1&order_by=modified%20desc
    

    The reponse header contains the following information:

    Records-Rows: 50
    Records-Start: 0
    Records-Total: 2000
    

    Returns a list of tags from your SalesSeek account.

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/tags

    Request Query Parameters

    Parameter Description
    rows The maximum number of organizations to be returned.
    start The row number to start to retrieve data. (0 for start)
    order_by Results are ordered by the provided field name followed by &desc or &asc

    The response header contains the total number of records.

    Response Header Parameters

    Parameter Description
    Records-Rows The number of rows returned in this request
    Records-Start The start number of rows in this request (out of total)
    Records-Total The total number of rows available

    Custom Field API

    Custom Field Attributes

    An example response body for a custom field would look like this:

    {
        "id": "409306ef-1e5c-4763-836a-819e65646da9",
        "name": "Data Status",
        "type": "dropDown",
        "view": "individuals",
        "required": false,
        "options": [
          {
            "id": "f84cca3b-b096-4331-9f40-dd73d830a8b4",
            "value": "subscribed"
          },
          {
            "id": "58562322-0efc-4ed8-8eb3-e5b05f0f5501",
            "value": "unsubscribed"
          },
          {
            "id": "0ff89e07-ff32-4082-93f9-d048d4439b29",
            "value": "pending"
          },
          {
            "id": "6fc3036a-8ccd-428a-b609-639d8ac438b9",
            "value": "cleaned"
          }
        ],
        "value": {
          "options": [
            {
              "id": "f84cca3b-b096-4331-9f40-dd73d830a8b4",
              "value": "subscribed"
            },
            {
              "id": "58562322-0efc-4ed8-8eb3-e5b05f0f5501",
              "value": "unsubscribed"
            },
            {
              "id": "0ff89e07-ff32-4082-93f9-d048d4439b29",
              "value": "pending"
            },
            {
              "id": "6fc3036a-8ccd-428a-b609-639d8ac438b9",
              "value": "cleaned"
            }
          ]
        },
        "creator_id": "8baadb17-d37e-47f7-b116-0f15c06f297e",
        "last_modified_by_id": "8baadb17-d37e-47f7-b116-0f15c06f297e",
        "owner_id": "8baadb17-d37e-47f7-b116-0f15c06f297e",
        "created": "2017-04-28T16:15:08.434816",
        "modified": "2017-04-28T16:15:08.434816",
        "order": 3,
        "default": null,
        "params": null, 
      }
    
    Parameter Description
    id The unique identifier for this custom field String
    name The name for the custom field, this will appear in the SalesSeek UI String
    type The type of custom field (text,dropDown, checkbox, currency, date, individual, number, organization, paragraph, url, urlImage)Enum (String)
    view The record type the custom field should appear on (individuals, organizartions, opportunities) Enum (String)
    required Set to true if this field is a required field Boolean
    options List of options if field type is set to dropDown Object
    options[x].id ID for the option in the dropdown custom field String
    options[x].value The value for the option in the dropdown custom field String
    creator_id ID for the User that created this custom field String
    last_modified_by_id The ID for the User that last modified this custom field String
    owner_id The ID for the User that owns this custom field String
    created Custom field creation timestamp Timestamp (ISO 8601)
    modified Custom field last modified timestamp Timestamp (ISO 8601)
    order The position that this custom field should be displayed in the UI Integer
    default The default value for the custom field (Mixed)
    params Extra parameters for the custom field (values depend on the type value) Object
    params.show_preview Set to true if a url field is to show a preview of the resource using the URI Boolean
    params.preview_height The height of the preview when getting the resource from a url field Int

    Get Custom Field

    Returns the custom field matching the custom_field_id

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/custom_fields/{custom_field_id}

    Request Query Parameters

    Parameter Description
    custom_field_id The ID for the custom field you'd like to retrieve String

    Create Custom Field

    An example request body to create a date custom field called 'First Seen Date' on individuals would look like:

    {
      "name": "First Seen Date",
      "type": "date",
      "view": "individuals",
      "value": {
        "default": ""
      },
      "required": false
    }
    

    Creates a new custom field and then returns the newly created custom field.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/custom_fields/

    Update Custom Field

    A sample request body to custom field name to 'Last Seen Date' would be:

    {
      "name": "Last Seen Date"
    }
    

    Updates a custom field by custom_field_id and returns the resulting custom field.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/custom_fields/{custom_field_id}

    Request Query Parameters

    Parameter Description
    custom_field_id The unique ID for the individual to be updated.

    Request Body

    The only fields updated are the one passed on the request body JSON. You can pass any attribute to update.

    Delete Custom Field

    Deletes the custom field matching the custom_field_id

    Request URL

    DELETE https://{CLIENT_ID}.salesseek.net/api/custom_fields/{custom_field_id}

    Request Query Parameters

    Parameter Description
    custom_field_id The unique ID for the custom field to be updated.

    List Custom Fields

    An example request to get all custom fields for the Individual view in your SalesSeek account:

    GET https://example.salesseek.net/api/custom_fields?start=0&rows=-1&order_by=modified%20desc&filter=view%3Dindividuals
    

    The reponse header contains the following information:

    Records-Rows: 50
    Records-Start: 0
    Records-Total: 2000
    

    Returns the list of custom fields for the chosen record type.

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/custom_fields

    Request Query Parameters

    Parameter Description
    rows The maximum number of organizations to be returned.
    start The row number to start to retrieve data. (0 for start)
    order_by Results are ordered by the provided field name followed by desc or asc
    filter=view The record type that the custom fields are related to (individuals, deals, organizations)

    Response Header Parameters

    Parameter Description
    Records-Rows The number of rows returned in this request
    Records-Start The start number of rows in this request (out of total)
    Records-Total The total number of rows available

    User API

    User Attributes

    {
        "id": "40575ca1-381c-4542-a556-e3c2d81ef67e",
        "name": "Example User",
        "email_address": "example@salesseek.com",
        "is_admin": true,
        "email_signature": "",
        "ical_url": "/users/40575ca1-381c-4542-a556-e3c2d81ef67e/icalendar_feed?token=11753b32-c9c3-45f8-948a-e2682ae7c8db",
        "created": "2017-03-07T17:33:48.856990",
        "modified": "2017-08-23T12:40:39.122870",
        "password_reset_required": false,
        "notification_settings": {
          "instant_email_notifications": "False",
          "new_lead_email_notification": "False",
          "evening_email_notification": "False",
          "morning_email_notification": "False"
        },
        "preferences": {
          ...
        },
        "quota": [
          {
            "value": 1000,
            "bucket_id": "b42b5b3f-8ee4-43f5-8992-a6779beb78e0"
          },
          {
            "value": 0,
            "bucket_id": "4dfec57c-3525-49da-b7ef-a84523aeabef"
          },
          {
            "value": 0,
            "bucket_id": "16228274-85aa-459b-ad78-fa9ae69de302"
          }
        ]
    }
    
    
    Parameter Description
    id The unique identifier for this user String
    name The name given to this user String
    email_address Email address for this user, used to login to SalesSeek String
    is_admin Set to true if this user is an adminstrator Boolean
    email_signature This users email signature in HTML. Used in Direct Emails String
    ical_url URL for the user iCal connection String (URL)
    created User creation timestamp Timestamp (ISO 8601)
    modified User last modified timestamp Timestamp (ISO 8601)
    password_reset_required Set to true if this User will be required to reset their password when they next login Boolean
    notification_settings Object contianing users email notification settings Object
    notification_settings.instant_email_notifications Set to 'True' if user has instant email notifications when a task has been assigned to them enabled String
    notification_settings.evening_email_notification Set to 'True' if user has enabled a daily email of all completed tasks, and today's uncompleted tasks String
    notification_settings.morning_email_notification Set to 'True' if user has enabled a daily email with tasks that need completing today String
    notification_settings.new_lead_email_notification Set to 'True' if user has enabled a an email each time a new lead is assigned to them String
    preferences Object containing this users app preferences (not editable via the API) Object
    quota Object continaing targets for each revenue bucket for this user (used in Sales Manager Dashboard) Array (Object)
    quota[x].bucket_id The ID for the bucket this quota is related to String
    quota[x].value The target value for this bucket Double

    Get User

    Returns the user matching the user_id

    Request URL

    GET https://{CLIENT_ID}.salesseek.net/api/users/{user_id}

    Parameter Description
    user_id The ID for the user you'd like to retrieve

    Create User

    An example request body to create a user look like:

    {
        "email_address":"example@example.com",
        "name":"example"
    }
    

    Creates a new user and then returns the newly created user.

    Request URL

    POST https://{CLIENT_ID}.salesseek.net/api/users/

    When adding a new SalesSeek user, the user is emailed a temporary password. During first login the user will be able to set their own password.

    Update User

    A sample request body to change the user email address

    {
        "email_address": "example@example.co.uk"
    }
    

    Updates values of the user by user_id. The resulting deal is returned.

    Request URL

    PATCH https://{CLIENT_ID}.salesseek.net/api/users/{user_id}

    Parameter Description
    user_id The ID for the deal you'd like to update

    Request Body

    The only fields updated are the one passed on the request body JSON. You can pass attributes to update.

    Delete User

    Deletes the user matching the user_id

    Request URL

    DELETE https://{CLIENT_ID}.salesseek.net/api/users/{user_id}

    Request Query Parameters

    Parameter Description
    user_id The unique ID for the user to be deleted.

    When deleting a user all records owned by this user will be reassigned to the user performing the deletion. Any activity records will remain associated with the deleted user.