{"id":13476,"date":"2023-01-10T12:03:45","date_gmt":"2023-01-10T12:03:45","guid":{"rendered":"https:\/\/www.stoneshot.com\/learn\/?page_id=13476"},"modified":"2026-02-23T16:11:06","modified_gmt":"2026-02-23T16:11:06","slug":"api-documentation","status":"publish","type":"page","link":"https:\/\/www.stoneshot.com\/learn\/api-documentation\/","title":{"rendered":"API Documentation"},"content":{"rendered":"<p> <script\n  src=\"https:\/\/code.jquery.com\/jquery-3.6.3.slim.min.js\"\n  integrity=\"sha256-ZwqZIVdD3iXNyGHbSYdsmWP\/\/UBokj2FHAxKuSBKDSo=\"\n  crossorigin=\"anonymous\"><\/script><\/p>\n<style>\n\tbody > div.jumbotron_new.inner-jumbotron.jumbotron-inner-fix.noise-break.header_custom_height {opacity: 0;min-height: 0px;height: 0px;}\n\tbody > div.jumbotron_new > div > div{display:none;}\n\t#api-sidebar a {display:block;}\n\t.nav-parent {font-size: 16px; color:#38a05c !important; font-weight:bold;}\n\t.nav-child {font-size:14px; color:#38a05c !important;}\n\t.nav-child-group {margin-bottom:40px;}\n\th2 {margin-top:0 !important;}\n\th4 {display:inline-block}\n\th5 {display:inline-block;}\n\t.more {display:inline; float:right; font-size:14px !important; cursor:pointer; padding-bottom:0 !important;}\n\t.less {display:none; float:right; font-size:14px !important; cursor:pointer; padding-bottom:0 !important;}\n\t.section {padding:100px 0 0 0; border-bottom:1px solid #ccc;}\n\t.section p {font-size: 16px;}\n\t.method {border-top:1px solid #ccc; padding: 20px 0 0 0;}\n\t.method-detail {display:none;}\n\t#api {padding-top:0;}\n\t.request-line {font-size: 15px; margin-bottom: 20px;}\n\t.request-verb {margin-right:15px; background-color:#38a05c; padding:3px 5px; font-weight:bold; color:#fff;}\n\t.request-code {font-family:\"Lucida Console\", Monaco, monospace;}\n\t.parameter {background-color:#999; font-family:\"Lucida Console\"; padding: 4px 8px; color:#fff; margin-right:10px;}\n\t.param-wrap {border-bottom: 1px dotted #ccc; margin-bottom: 15px;}\n\t.parameter-type {font-size: 12px; font-style:italic;}\n\t.request-item-desc {margin-bottom:15px; line-height:24px;}\n\t.response-item {font-family:\"Lucida Console\", Monaco, monospace; border:2px solid #38a05c; padding:3px 5px; display:inline-block; margin-bottom:10px;}\n\t.error-item {font-family:\"Lucida Console\", Monaco, monospace; border:2px solid #ff0000; padding:3px 5px; display:inline-block; margin-bottom:10px;}\n\t#gettingstarted h4 {margin-top:30px !important;}\n\t.mt-20 {margin-top:20px !important}\n\t.available-fields-title {margin-bottom:15px;}\n\t.available-fields {margin-bottom:15px;}\t\n\t.available-fields span {font-size: 13px; display:inline-block; background-color:#aaa; margin-right: 5px; color:#fff; padding:3px 6px 1px 6px; margin-bottom: 5px;font-family:\"Lucida Console\", Monaco, monospace;}\t\n\t@media only screen and (max-width: 992px) {\n\t\t#api-sidebar {position: relative; display:none;}\n\t}\n        .param-wrap {\n    border-bottom: 1px dotted #ccc;\n    margin-bottom: 15px;\n    display:flex;\n}\n.request-verb {\n    margin-right: 15px;\n    background-color: #0099d8;\n    padding: 3px 5px;\n    font-weight: bold;\n    color: #fff;\n}\n.nav-parent {\nfont-size: 20px;\n    color: #0099d8!important;\n    font-weight: bold;\n    font-size: 16px;\n    line-height: 3.5;\n    letter-spacing: 0.3px;\n    text-decoration: none!important;\n}\n.nav-child {\n    font-size: 14px;\n    color: #0099d8!important;\n    line-height: 0.5;\n    letter-spacing: 0.3px;\n}\n.col-md-3 {\n    width: 25%;\n    float: left;\n}\n.col-md-4 {\n    width: 33.33%;\n    float: left;\n}\n.col-md-8 {\n    width: 66.66%;\n    float: left;\n}\n.col-md-9 {\n    width: 75%;\n    float: left;\n}\npre {\n    display: block;\n    padding: 9.5px;\n    margin: 0 0 10px;\n    font-size: 13px;\n    line-height: 1.42857143;\n    color: #333;\n    word-break: break-all;\n    word-wrap: break-word;\n    background-color: #f5f5f5;\n    border: 1px solid #ccc;\n    border-radius: 4px;\n}\npre code {\n    padding: 0;\n    font-size: inherit;\n    color: inherit;\n    white-space: pre-wrap;\n    background-color: transparent;\n    border-radius: 0;\n}\t\n.featured-post-background-PanelBlue{display:none;}\n.siButtonB {\n    border-radius: 4px;\n    background: #f6f7f7!important;\n    padding: 10px 24px;\n    box-shadow: none!important;\n}\n<\/style>\n<div class=\"container-fluid\" style=\"padding-top:30px\">\n<div class=\"row\">\n<div class=\"col-md-2\">\n<div id=\"api-sidebar\">\n<div><\/div>\n<p>\t\t\t\t\t<a href=\"#gettingstarted\" class=\"nav-parent\">Getting started<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#authentication\" class=\"nav-child\">Authentication<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#requests\" class=\"nav-child\">Requests<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#responsestatuscodes\" class=\"nav-child\">Response status codes<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#ratelimiting\" class=\"nav-child\">Rate limiting<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#contactmatching\" class=\"nav-child\">Contact matching<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#campaigns\" class=\"nav-parent\">Campaigns<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#getcampaigns\" class=\"nav-child\">Get campaigns<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getcampaign\" class=\"nav-child\">Get campaign<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getcampaigncontacts\" class=\"nav-child\">Get campaign contacts<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getcampaignsends\" class=\"nav-child\">Get campaign sends<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getcampaignopens\" class=\"nav-child\">Get campaign opens<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getcontactcampaignopens\" class=\"nav-child\">Get contact campaign opens<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getcampaignclicks\" class=\"nav-child\">Get campaign clicks<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getcontactcampaignclicks\" class=\"nav-child\">Get contact campaign clicks<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getcampaignlinks\" class=\"nav-child\">Get campaign links<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getcampaignunsubscribes\" class=\"nav-child\">Get campaign unsubscribes<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#addcontacttocampaign\" class=\"nav-child\">Add contact to campaign<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#contacts\" class=\"nav-parent\">Contacts<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#getcontacts\" class=\"nav-child\">Get contacts<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#createcontact\" class=\"nav-child\">Create contact<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getcontact\" class=\"nav-child\">Get contact<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#updatecontact\" class=\"nav-child\">Update contact<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#create-or-updatecontact\" class=\"nav-child\">Create or Update contact<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getcampaignactivity\" class=\"nav-child\">Get contact campaign activity<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#contentdistributionsystem\" class=\"nav-parent\">Content distribution system<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#getcontentpreferences\" class=\"nav-child\">Get content preferences<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getcontentpreference\" class=\"nav-child\">Get content preference<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#updatecontentpreference\" class=\"nav-child\">Update content preference<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#contactcustomfields\" class=\"nav-parent\">Contact custom fields<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#getcontactcustomfields\" class=\"nav-child\">Get contact custom fields<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#documentdistributionsystem\" class=\"nav-parent\">Document distribution system<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#getdocumentpreferences\" class=\"nav-child\">Get document preferences<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#emailpreferences\" class=\"nav-parent\">Email preferences<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#getemailpreferences\" class=\"nav-child\">Get email preferences<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getemailpreference\" class=\"nav-child\">Get email preference<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#updateemailpreference\" class=\"nav-child\">Update email preference<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#events\" class=\"nav-parent\">Events<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#getevents\" class=\"nav-child\">Get events<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getevent\" class=\"nav-child\">Get event<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getsessions\" class=\"nav-child\">Get event sessions<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getsession\" class=\"nav-child\">Get event session<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getsessioncontacts\" class=\"nav-child\">Get event session contacts<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getspeakers\" class=\"nav-child\">Get speakers<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getspeaker\" class=\"nav-child\">Get speaker<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getvenues\" class=\"nav-child\">Get venues<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getvenue\" class=\"nav-child\">Get venue<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#feeds\" class=\"nav-parent\">Feeds<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#getarticles\" class=\"nav-child\">Get feed articles<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getarticle\" class=\"nav-child\">Get feed article<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#files\" class=\"nav-parent\">Files<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#getfiles\" class=\"nav-child\">Get files<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#uploadfile\" class=\"nav-child\">Upload a file<\/a>\n\t\t\t\t\t<\/div>\n<p>                                        <a class=\"nav-parent\" href=\"#forms\">Forms<\/a><\/p>\n<div class=\"nav-child-group\">\n                                        <a class=\"nav-child\" href=\"#getform\">Get form<\/a><br \/>\n                                        <a class=\"nav-child\" href=\"#getforms\">Get forms<\/a><br \/>\n                                        <a class=\"nav-child\" href=\"#getformsubmissions\">Get form submissions<\/a>\n                                        <\/div>\n<p>\t\t\t\t\t<a href=\"#lists\" class=\"nav-parent\">Lists<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#getlists\" class=\"nav-child\">Get lists<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#createlist\" class=\"nav-child\">Create list<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getlist\" class=\"nav-child\">Get list<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getlistcontacts\" class=\"nav-child\">Get list contacts<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#addcontacttolist\" class=\"nav-child\">Add contact to list<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#removecontactfromlist\" class=\"nav-child\">Remove contact from list<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#ping\" class=\"nav-parent\">Ping<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#ping request\" class=\"nav-child\">Ping request<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#segmentation\" class=\"nav-parent\">Segmentation<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#getsegmentations\" class=\"nav-child\">Get segmentations<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getsegmentation\" class=\"nav-child\">Get segmentation<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#tags\" class=\"nav-parent\">Tags<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#gettags\" class=\"nav-child\">Get tag<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#createtag\" class=\"nav-child\">Create tag<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#gettag\" class=\"nav-child\">Get tag<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#updatetag\" class=\"nav-child\">Update tag<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#templates\" class=\"nav-parent\">Templates<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#gettemplates\" class=\"nav-child\">Get templates<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#gettemplate\" class=\"nav-child\">Get template<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#users\" class=\"nav-parent\">Users<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#getusers\" class=\"nav-child\">Get users<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getuser\" class=\"nav-child\">Get user<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#updateuser\" class=\"nav-child\">Update user<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#visittracking\" class=\"nav-parent\">Visit Tracking<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#getsites\" class=\"nav-child\">Get sites<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getsitevisitors\" class=\"nav-child\">Get site visitors<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getsitevisitor\" class=\"nav-child\">Get site visitor<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getvisitactivites\" class=\"nav-child\">Get site visits<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getvisitactivitesforcontact\" class=\"nav-child\">Get contact site visits<\/a><br \/>\n\t\t\t\t\t\t<a class=\"nav-child\" href=\"#getgoalsforsite\">Get goals for site<\/a><br \/>\n\t\t\t\t\t\t<a class=\"nav-child\" href=\"#getgoalforsite\">Get goal for site<\/a><br \/>\n\t\t\t\t\t\t<a class=\"nav-child\" href=\"#getconversionsforsite\">Get conversions for site<\/a><br \/>\n\t\t\t\t\t\t<a class=\"nav-child\" href=\"#getconversionsforgoal\">Get conversions for goal<\/a>\n\t\t\t\t\t<\/div>\n<p>\t\t\t\t\t<a href=\"#workflows\" class=\"nav-parent\">Workflows<\/a><\/p>\n<div class=\"nav-child-group\">\n\t\t\t\t\t\t<a href=\"#getworkflows\" class=\"nav-child\">Get workflows<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getworkflow\" class=\"nav-child\">Get workflow<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#getworkflowcontacts\" class=\"nav-child\">Get workflow contacts<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#addcontacttoworkflow\" class=\"nav-child\">Add contact to workflow<\/a><br \/>\n\t\t\t\t\t\t<a href=\"#removecontactfromworkflow\" class=\"nav-child\">Remove contact from workflow<\/a>\n\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"col-md-9\" style=\"padding-bottom: 100px;\">\n<div id=\"api\" class=\"section\">\n<h2>API Documentation<\/h2>\n<p>Integrate StoneShot data with your website, CRM, CMS and much more to implement smarter marketing strategies and give your clients a personalised experience. Here is everything you need to get started.<\/p>\n<\/p><\/div>\n<div id=\"gettingstarted\" class=\"section\">\n<h3>Getting started<\/h3>\n<h4 id=\"authentication\">Authentication<\/h4>\n<p>The StoneShot API currently supports authentication via an API Key using basic HTTP Authentication. You can generate your API key from the Integrations page when logged into your StoneShot account. When making an API request you will provide your API key (Base64 encoded) as the password, the username value can be left empty as it is not used for authentication.<\/p>\n<p>To quickly test calls to the API with your API key, you can use a tool such as <a href=\"https:\/\/curl.haxx.se\/\">cURL<\/a> via the command line. You&#8217;ll find cURL examples for each method in the following guide. Here&#8217;s an example of a cURL request to the ping endpoint to check the current status of the API.<\/p>\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/ping\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"  \r\n<\/code><\/pre>\n<h4 id=\"requests\">Requests<\/h4>\n<p>Requests to the StoneShot API are formed based on a number of rules and parameters. Full details of the supported parameters for each request are detailed in the documentation below. Here is a description of each of the key pieces that make up a request to the API.<\/p>\n<h5>Root<\/h5>\n<p>All requests to the StoneShot API will stem from the API root:<\/p>\n<pre><code>https:\/\/api.stoneshot.com\/v1\/<\/code><\/pre>\n<h5 class=\"mt-20\">Path parameters<\/h5>\n<p>Path parameters are required when targeting a specific record, here&#8217;s an example of a request endpoint to retrieve a specific list, in this case [list_id] is the path parameter.<\/p>\n<pre><code>https:\/\/api.stoneshot.com\/v1\/lists\/[list_id]<\/code><\/pre>\n<h5 class=\"mt-20\">Query parameters<\/h5>\n<p>Query parameters are used in requests to the API to restrict the properties returned in a given request by explicitly including those fields as part of the &#8216;select&#8217; query parameter. By default the common fields will be returned as part of any request, the &#8216;select&#8217; query parameter can be included if the defaults do not cover your needs. A &#8216;select&#8217; query string should be included for each field required.<\/p>\n<p>Here&#8217;s an example of the &#8216;select&#8217; query parameter being used to only bring back the name field when retrieving all lists.<\/p>\n<pre><code>https:\/\/api.stoneshot.com\/v1\/lists?select=name<\/code><\/pre>\n<p class=\"mt-20\">Query parameters can also be used to filter, sort and limit results. Examples of using these query parameters can be found within each request detail in the following documentation. Here&#8217;s an example of a request to get no more than 50 lists with &#8216;StoneShot&#8217; in the name sorted by most recently created.<\/p>\n<pre><code>https:\/\/api.stoneshot.com\/v1\/lists?name=stoneshot&count=50&sort_by=-create_date_utc<\/code><\/pre>\n<h5 class=\"mt-20\">Body parameters<\/h5>\n<p>Body parameters are often required for POST and PATCH requests to the StoneShot API. The body of the request should be in JSON format, examples of body parameters can be found in the cURL snippets for each of the requests in the following documentation. Here&#8217;s a short example of the body required to create a new static list.<\/p>\n<pre><code>{\r\n  \"name\": \"StoneShot API List\",\r\n  \"tags\":[\r\n    {\r\n      \"name\": \"api\"\r\n    }\r\n  ],\r\n  \"teams\":[\r\n    {\r\n      \"name\": \"StoneShot\"\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<h5 class=\"mt-20\">Responses<\/h5>\n<p>API responses are served in JSON (JavaScript Object Notation) format. This includes both success and error responses.<\/p>\n<p>Example responses are given for each request in the following documentation.<\/p>\n<h4 id=\"responsestatuscodes\">Response status codes<\/h4>\n<p>Each request to the API will return a response partnered by a HTTP status code representing the status of the request. A successful request will return a HTTP Status 200 response and the relevant response object. For example when creating a list via the API, on successful create you will receive a HTTP status 200 and the newly created list object in the response.<\/p>\n<p>Requests that fail will return the relevant HTTP status code along with a custom response code and message which will provide more detail on the error itself. Here&#8217;s an example of an error returned when an invalid API key is offered.<\/p>\n<pre><code>{  \r\n  \"code\": 104,\r\n  \"message\": \"Invalid key\"\r\n}<\/code><\/pre>\n<h4 id=\"ratelimiting\">Rate limiting<\/h4>\n<p>The StoneShot API endpoints are subject to rate limiting based on the number of requests over a period of time. The default rate is limit 10,000 requests every 60 minutes.<\/p>\n<p>Requests made to the API once the limit has been reached, will return a response such as below, the response headers will include additional information on the your rate limit and the time at which it is reset. If you find that you are regularly hitting the limit, please contact StoneShot support to discuss your options.<\/p>\n<pre><code>X-Rate-Limit-Limit: 10000\r\nX-Rate-Limit-Remaining: 0\r\nX-Rate-Limit-Reset: \"17\/01\/2020 17:43:25\"\r\n\r\n{\r\n  \"code\": 114,\r\n  \"message\": \"Too many requests in time frame; check RateLimit headers\"\r\n}<\/code><\/pre>\n<h4 id=\"contactmatching\">Contact matching<\/h4>\n<p>A number of the API requests will involve retrieving or updating an existing contact record. The API supports a number of individual StoneShot fields in order to determine which contact to match on, these fields being:<\/p>\n<ul>\n<li>Member Url Id<\/li>\n<li>StoneShot Contact Id<\/li>\n<li>CRM ID (SalesforceId, Microsoft Dynamics Id, Siebel Id or Unique User Id)<\/li>\n<li>Email Address (Cannot be used as a path parameter)<\/li>\n<\/ul>\n<p>When one of the seven identifiers is required in a request to the API, it should be passed through using the &#8216;identifier&#8217; keyword. The matching criteria will then be determined automatically as part of the request.<\/p>\n<\/p><\/div>\n<div id=\"campaigns\" class=\"section\">\n<h3>Campaigns<\/h3>\n<p>Retrieve your contacts who have been sent a campaign or send a campaign to your contacts.<\/p>\n<div class=\"method\">\n<h4 id=\"getcampaigns\">Get campaigns<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/campaigns<\/span><\/div>\n<p>Retrieve campaigns associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>campaign_id<\/span><span>name<\/span><span>date_sent_utc<\/span><span>sends<\/span><span>total_opens<\/span><span>total_clicks<\/span><span>bounces<\/span><span>reach<\/span><span>opt_outs<\/span><span>open_rate_%<\/span><span>click_rate_%<\/span><span>click_to_open_rate_%<\/span><span>delivery_rate_%<\/span><span>last_open_or_click_date_utc<\/span><span>communication_type<\/span><span>audience<\/span><span>tags.name<\/span><span>is_ab<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>subject<\/span><span>from_email<\/span><span>from_name<\/span><span>unique_opens<\/span><span>unique_desktop_opens<\/span><span>unique_mobile_opens<\/span><span>unique_other_opens<\/span><span>unique_clicks<\/span><span>unique_desktop_clicks<\/span><span>unique_mobile_clicks<\/span><span>unique_other_clicks<\/span><span>desktop_opens<\/span><span>mobile_opens<\/span><span>other_opens<\/span><span>desktop_clicks<\/span><span>mobile_clicks<\/span><span>other_clicks<\/span><span>desktop_glances<\/span><span>desktop_skims<\/span><span>desktop_reads<\/span><span>desktop_opens_unknown_length<\/span><span>mobile_glances<\/span><span>mobile_skims<\/span><span>mobile_reads<\/span><span>mobile_opens_unknown_length<\/span><span>desktop_open_rate_%<\/span><span>mobile_open_rate_%<\/span><span>engagement_glanced_%<\/span><span>engagement_skimmed_%<\/span><span>engagement_read_%<\/span><span>bounce_rate_%<\/span><span>form_submissions<\/span><span>tags.tag_id<\/span><span>product<\/span><span>list_name<\/span><span>folder_id<\/span><span>campaign_code<\/span><span>campaignab<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is campaign_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on campaign name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">tag<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on campaigns with a given tag.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/campaigns\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"campaigns\": [\r\n    {\r\n      \"campaign_id\": 0,\r\n      \"name\": \"string\",\r\n      \"date_sent_utc\": \"2019-06-13T15:00:45Z\",\r\n      \"sends\": 0,\r\n      \"total_opens\": 0,\r\n      \"total_clicks\": 0,\r\n      \"bounces\": 0,\r\n      \"reach\": 0,\r\n      \"opt-outs\": 0,\r\n      \"open_rate_%\": 0.0,\r\n      \"click_rate_%\": 0.0,\r\n      \"click_to_open_rate_%\": 0.0,\r\n      \"delivery_rate_%\": 0.0,\r\n      \"last_open_or_click_date_utc\": \"2019-06-13T15:00:45Z\",\r\n      \"tags\": [\r\n        {\r\n          \"name\": \"string\"\r\n        }\r\n      ],\r\n      \"communication_type\": \"string\",\r\n      \"audience\": \"string\",\r\n      \"is_ab\": bool \r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getcampaign\">Get campaign<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/campaigns\/{campaign_id}<\/span><\/div>\n<p>Get information for a specific campaign in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">campaign_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot campaign id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>campaign_id<\/span><span>name<\/span><span>date_sent_utc<\/span><span>sends<\/span><span>total_opens<\/span><span>total_clicks<\/span><span>bounces<\/span><span>reach<\/span><span>opt_outs<\/span><span>open_rate_%<\/span><span>click_rate_%<\/span><span>click_to_open_rate_%<\/span><span>delivery_rate_%<\/span><span>last_open_or_click_date_utc<\/span><span>communication_type<\/span><span>audience<\/span><span>tags.name<\/span><span>is_ab<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>subject<\/span><span>from_email<\/span><span>from_name<\/span><span>unique_opens<\/span><span>unique_desktop_opens<\/span><span>unique_mobile_opens<\/span><span>unique_other_opens<\/span><span>unique_clicks<\/span><span>unique_desktop_clicks<\/span><span>unique_mobile_clicks<\/span><span>unique_other_clicks<\/span><span>desktop_opens<\/span><span>mobile_opens<\/span><span>other_opens<\/span><span>desktop_clicks<\/span><span>mobile_clicks<\/span><span>other_clicks<\/span><span>desktop_glances<\/span><span>desktop_skims<\/span><span>desktop_reads<\/span><span>desktop_opens_unknown_length<\/span><span>mobile_glances<\/span><span>mobile_skims<\/span><span>mobile_reads<\/span><span>mobile_opens_unknown_length<\/span><span>desktop_open_rate_%<\/span><span>mobile_open_rate_%<\/span><span>engagement_glanced_%<\/span><span>engagement_skimmed_%<\/span><span>engagement_read_%<\/span><span>bounce_rate_%<\/span><span>form_submissions<\/span><span>tags.tag_id<\/span><span>html_share_link<\/span><span>text_share_link<\/span><span>product<\/span><span>list_name<\/span><span>folder_id<\/span><span>campaign_code<\/span><span>campaignab<\/span>\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/campaigns\/[campaign_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"campaign\": [\r\n    {\r\n      \"campaign_id\": 0,\r\n      \"name\": \"string\",\r\n      \"date_sent_utc\": \"2019-06-13T15:00:45Z\",\r\n      \"sends\": 0,\r\n      \"total_opens\": 0,\r\n      \"total_clicks\": 0,\r\n      \"bounces\": 0,\r\n      \"reach\": 0,\r\n      \"opt-outs\": 0,\r\n      \"open_rate_%\": 0.0,\r\n      \"click_rate_%\": 0.0,\r\n      \"click_to_open_rate_%\": 0.0,\r\n      \"delivery_rate_%\": 0.0,\r\n      \"last_open_or_click_date_utc\": \"2019-06-13T15:00:45Z\",\r\n      \"tags\": [\r\n        {\r\n          \"name\": \"string\"\r\n        }\r\n      ],\r\n      \"communication_type\": \"string\",\r\n      \"audience\": \"string\",\r\n      \"is_ab\": bool\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getcampaigncontacts\">Get campaign contacts<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/campaigns\/{campaign_id}\/contacts<\/span><\/div>\n<p>Get contacts who have been sent a specified campaign.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">campaign_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot campaign id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>email<\/span><span>title<\/span><span>first_name<\/span><span>last_name<\/span><span>company<\/span><span>create_date_utc<\/span><span>contact_id<\/span><span>last_active_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>middle_name<\/span><span>website<\/span><span>job_title<\/span><span>telephone<\/span><span>telephone_ext<\/span><span>fax<\/span><span>mobile_number<\/span><span>home_number<\/span><span>address_1<\/span><span>address_2<\/span><span>address_3<\/span><span>address_4<\/span><span>city<\/span><span>county<\/span><span>postcode<\/span><span>country<\/span><span>opt_in<\/span><span>custom_1<\/span><span>custom_2<\/span><span>custom_3<\/span><span>custom_4<\/span><span>custom_5<\/span><span>custom_6<\/span><span>custom_7<\/span><span>custom_8<\/span><span>custom_9<\/span><span>custom_10<\/span><span>custom_11<\/span><span>custom_12<\/span><span>prefer_html<\/span><span>create_date_utc<\/span><span>is_bounce<\/span><span>salesforce_account_id<\/span><span>salesforce_owner_id<\/span><span>double_opt_in_status<\/span><span>unique_user_id<\/span><span>salesforce_id<\/span><span>siebel_id<\/span><span>dynamics_id<\/span><span>segments.segment_id<\/span><span>segments.name<\/span><span>segments.segmentation.name<\/span><span>segments.segmentation.segmentation_id<\/span><span>email_preferences.segment_id<\/span><span>email_preferences.name<\/span><span>email_preferences.segmentation.name<\/span><span>email_preferences.segmentation.segmentation_id<\/span><span>content_preferences.content_tag_id<\/span><span>content_preferences.tag.tag_id<\/span><span>content_preferences.tag.name<\/span><span>events.segment_id<\/span><span>events.name<\/span><span>events.segmentation.name<\/span><span>events.segmentation.segmentation_id<\/span><span>events.session.session_id<\/span><span>events.session.location<\/span><span>events.session.event.event_id<\/span><span>events.session.event.name<\/span><span>document_preferences.segment_id<\/span><span>document_preferences.name<\/span><span>document_preferences.segmentation.name<\/span><span>document_preferences.segmentation.segmentation_id<\/span><br \/>\n\t\t\t\t\t\t\t\t\t<span>custom_fields.value<\/span><span>custom_fields.custom_field.custom_field_id<\/span><span>custom_fields.custom_field.name<\/span><span>custom_fields.custom_field.display_name<\/span><span>contact_guid<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 500.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is contact_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">contact_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on a unique StoneShot contact id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact email address.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">first_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact first name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">last_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact last name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">company<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact company.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">job_title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact job title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">city<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact city.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">county<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact county.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">country<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact country.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact salesforce id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact siebel id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">dynamics_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact microsoft dynamics id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact unique external user id.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/campaigns\/[campaign_id]\/contacts\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contacts\": [\r\n    {\r\n      \"contact_id\": 0,\r\n      \"email\": \"string\",\r\n      \"title\": \"string\",\r\n      \"first_name\": \"string\",\r\n      \"last_name\": \"string\",\r\n      \"company\": \"string\",\r\n      \"create_date_utc\": \"2019-06-13T15:00:45Z\",\r\n      \"last_active_utc\": \"2020-08-06T15:03:10Z\"\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getcampaignsends\">Get campaign sends<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/campaigns\/{campaign_id}\/sends<\/span><\/div>\n<p>Get sends for a specified campaign.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">campaign_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot campaign id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>send_date_utc<\/span><span>contact.email<\/span><span>contact.title<\/span><span>contact.first_name<\/span><span>contact.last_name<\/span><span>contact.company<\/span><span>contact.create_date_utc<\/span><span>contact.contact_id<\/span><span>contact.last_active_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>contact.middle_name<\/span><span>contact.website<\/span><span>contact.job_title<\/span><span>contact.telephone<\/span><span>contact.telephone_ext<\/span><span>contact.fax<\/span><span>contact.mobile_number<\/span><span>contact.home_number<\/span><span>contact.address_1<\/span><span>contact.address_2<\/span><span>contact.address_3<\/span><span>contact.address_4<\/span><span>contact.city<\/span><span>contact.county<\/span><span>contact.postcode<\/span><span>contact.country<\/span><span>contact.opt_in<\/span><span>contact.custom_1<\/span><span>contact.custom_2<\/span><span>contact.custom_3<\/span><span>contact.custom_4<\/span><span>contact.custom_5<\/span><span>contact.custom_6<\/span><span>contact.custom_7<\/span><span>contact.custom_8<\/span><span>contact.custom_9<\/span><span>contact.custom_10<\/span><span>contact.custom_11<\/span><span>contact.custom_12<\/span><span>contact.prefer_html<\/span><span>contact.is_bounce<\/span><span>contact.salesforce_account_id<\/span><span>contact.salesforce_owner_id<\/span><span>contact.unique_user_id<\/span><span>contact.salesforce_id<\/span><span>contact.siebel_id<\/span><span>contact.dynamics_id<\/span><span>contact_guid<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 1000; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is send_date_utc descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">contact_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on a unique StoneShot contact id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact email address.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">first_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact first name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">last_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact last name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">company<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact company.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">job_title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact job title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">city<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact city.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">county<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact county.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">country<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact country.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact salesforce id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact siebel id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">dynamics_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact microsoft dynamics id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact unique external user id.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/campaigns\/[campaign_id]\/sends\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"sends\": [\r\n    {\r\n      \"send_date_utc\": \"2019-06-13T15:00:45Z\",\r\n      \"contact\": {\r\n        \"contact_id\": 0,\r\n        \"email\": \"string\",\r\n        \"title\": \"string\",\r\n        \"first_name\": \"string\",\r\n        \"last_name\": \"string\",\r\n        \"company\": \"string\",\r\n        \"create_date_utc\": \"2020-10-07T19:03:11Z\",\r\n        \"last_active_utc\": \"2020-12-22T16:29:30Z\"\r\n      }\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getcampaignopens\">Get campaign opens<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/campaigns\/{campaign_id}\/opens<\/span><\/div>\n<p>Get opens for a specified campaign.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">campaign_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot campaign id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>open_date_utc<\/span><span>device.name<\/span><span>device.type<\/span><span>contact.email<\/span><span>contact.title<\/span><span>contact.first_name<\/span><span>contact.last_name<\/span><span>contact.company<\/span><span>contact.create_date_utc<\/span><span>contact.contact_id<\/span><span>contact.last_active_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>contact.middle_name<\/span><span>contact.website<\/span><span>contact.job_title<\/span><span>contact.telephone<\/span><span>contact.telephone_ext<\/span><span>contact.fax<\/span><span>contact.mobile_number<\/span><span>contact.home_number<\/span><span>contact.address_1<\/span><span>contact.address_2<\/span><span>contact.address_3<\/span><span>contact.address_4<\/span><span>contact.city<\/span><span>contact.county<\/span><span>contact.postcode<\/span><span>contact.country<\/span><span>contact.opt_in<\/span><span>contact.custom_1<\/span><span>contact.custom_2<\/span><span>contact.custom_3<\/span><span>contact.custom_4<\/span><span>contact.custom_5<\/span><span>contact.custom_6<\/span><span>contact.custom_7<\/span><span>contact.custom_8<\/span><span>contact.custom_9<\/span><span>contact.custom_10<\/span><span>contact.custom_11<\/span><span>contact.custom_12<\/span><span>contact.prefer_html<\/span><span>contact.is_bounce<\/span><span>contact.salesforce_account_id<\/span><span>contact.salesforce_owner_id<\/span><span>contact.unique_user_id<\/span><span>contact.salesforce_id<\/span><span>contact.siebel_id<\/span><span>contact.dynamics_id<\/span><span>contact_guid<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 1000; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is open_date_utc descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">contact_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on a unique StoneShot contact id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact email address.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">first_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact first name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">last_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact last name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">company<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact company.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">job_title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact job title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">city<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact city.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">county<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact county.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">country<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact country.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact salesforce id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact siebel id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">dynamics_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact microsoft dynamics id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact unique external user id.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/campaigns\/[campaign_id]\/opens\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"opens\": [\r\n    {\r\n      \"open_date_utc\": \"2019-06-13T15:00:45Z\",\r\n      \"contact\": {\r\n        \"contact_id\": 0,\r\n        \"email\": \"string\",\r\n        \"title\": \"string\",\r\n        \"first_name\": \"string\",\r\n        \"last_name\": \"string\",\r\n        \"company\": \"string\",\r\n        \"create_date_utc\": \"2020-10-07T19:03:11Z\",\r\n        \"last_active_utc\": \"2020-12-22T16:29:30Z\"\r\n      }\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getcontactcampaignopens\">Get campaign opens for a specific contact<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/campaigns\/{campaign_id}\/opens\/contacts\/{identifier}<\/span><\/div>\n<p>Get opens for a contact in a specified campaign.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">campaign_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot campaign id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">identifier<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">A unique identifier for the contact. See <a class=\"matching-anchor\" href=\"#contactmatching\">contact matching<\/a> for a list of the supported identifiers.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>opens.open_date_utc<\/span><span>opens.device.name<\/span><span>opens.device.type<\/span><span>email<\/span><span>title<\/span><span>first_name<\/span><span>last_name<\/span><span>company<\/span><span>create_date_utc<\/span><span>contact_id<\/span><span>last_active_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>middle_name<\/span><span>website<\/span><span>job_title<\/span><span>telephone<\/span><span>telephone_ext<\/span><span>fax<\/span><span>mobile_number<\/span><span>home_number<\/span><span>address_1<\/span><span>address_2<\/span><span>address_3<\/span><span>address_4<\/span><span>city<\/span><span>county<\/span><span>postcode<\/span><span>country<\/span><span>opt_in<\/span><span>custom_1<\/span><span>custom_2<\/span><span>custom_3<\/span><span>custom_4<\/span><span>custom_5<\/span><span>custom_6<\/span><span>custom_7<\/span><span>custom_8<\/span><span>custom_9<\/span><span>custom_10<\/span><span>custom_11<\/span><span>custom_12<\/span><span>prefer_html<\/span><span>is_bounce<\/span><span>salesforce_account_id<\/span><span>salesforce_owner_id<\/span><span>unique_user_id<\/span><span>salesforce_id<\/span><span>siebel_id<\/span><span>dynamics_id<\/span><span>contact_guid<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/campaigns\/[campaign_id]\/opens\/contacts\/[identifier]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contact\": {\r\n    \"contact_id\": 0,\r\n    \"email\": \"string\",\r\n    \"title\": \"string\",\r\n    \"first_name\": \"string\",\r\n    \"last_name\": \"string\",\r\n    \"company\": \"string\",\r\n    \"create_date_utc\": \"2017-05-17T11:09:07Z\",\r\n    \"last_active_utc\": \"2021-01-05T15:24:14Z\",\r\n    \"opens\": [\r\n      {\r\n        \"open_date_utc\": \"2020-12-03T15:40:26Z\",\r\n        \"device\": {\r\n          \"name\": \"string\",\r\n          \"type\": \"string\"\r\n        }\r\n      }\r\n    ]\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getcampaignclicks\">Get campaign clicks<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/campaigns\/{campaign_id}\/clicks<\/span><\/div>\n<p>Get clicks for a specified campaign.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">campaign_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot campaign id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>click_date_utc<\/span><span>url<\/span><span>device.name<\/span><span>device.type<\/span><span>contact.email<\/span><span>contact.title<\/span><span>contact.first_name<\/span><span>contact.last_name<\/span><span>contact.company<\/span><span>contact.create_date_utc<\/span><span>contact.contact_id<\/span><span>contact.last_active_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>link_id<\/span><span>contact.middle_name<\/span><span>contact.website<\/span><span>contact.job_title<\/span><span>contact.telephone<\/span><span>contact.telephone_ext<\/span><span>contact.fax<\/span><span>contact.mobile_number<\/span><span>contact.home_number<\/span><span>contact.address_1<\/span><span>contact.address_2<\/span><span>contact.address_3<\/span><span>contact.address_4<\/span><span>contact.city<\/span><span>contact.county<\/span><span>contact.postcode<\/span><span>contact.country<\/span><span>contact.opt_in<\/span><span>contact.custom_1<\/span><span>contact.custom_2<\/span><span>contact.custom_3<\/span><span>contact.custom_4<\/span><span>contact.custom_5<\/span><span>contact.custom_6<\/span><span>contact.custom_7<\/span><span>contact.custom_8<\/span><span>contact.custom_9<\/span><span>contact.custom_10<\/span><span>contact.custom_11<\/span><span>contact.custom_12<\/span><span>contact.prefer_html<\/span><span>contact.is_bounce<\/span><span>contact.salesforce_account_id<\/span><span>contact.salesforce_owner_id<\/span><span>contact.unique_user_id<\/span><span>contact.salesforce_id<\/span><span>contact.siebel_id<\/span><span>contact.dynamics_id<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 1000; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is click_date_utc descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">contact_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on a unique StoneShot contact id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact email address.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">first_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact first name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">last_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact last name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">company<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact company.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">job_title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact job title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">city<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact city.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">county<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact county.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">country<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact country.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact salesforce id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact siebel id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">dynamics_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact microsoft dynamics id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact unique external user id.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/campaigns\/[campaign_id]\/clicks\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"clicks\": [\r\n    {\r\n      \"click_date_utc\": \"2019-06-13T15:00:45Z\",\r\n      \"url\": \"string\",\r\n      \"device\": {\r\n        \"name\": \"string\",\r\n\t\"type\": \"string\"\r\n      },\r\n      \"contact\": {\r\n        \"contact_id\": 0,\r\n        \"email\": \"string\",\r\n        \"title\": \"string\",\r\n        \"first_name\": \"string\",\r\n        \"last_name\": \"string\",\r\n        \"company\": \"string\",\r\n        \"create_date_utc\": \"2020-10-07T19:03:11Z\",\r\n        \"last_active_utc\": \"2020-12-22T16:29:30Z\"\r\n      }\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getcontactcampaignclicks\">Get campaign clicks for a specific contact<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/campaigns\/{campaign_id}\/clicks\/contacts\/{identifier}<\/span><\/div>\n<p>Get clicks for a contact in a specified campaign.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">campaign_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot campaign id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">identifier<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">A unique identifier for the contact. See <a class=\"matching-anchor\" href=\"#contactmatching\">contact matching<\/a> for a list of the supported identifiers.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>clicks.click_date_utc<\/span><span>clicks.url<\/span><span>clicks.device.name<\/span><span>clicks.device.type<\/span><span>email<\/span><span>title<\/span><span>first_name<\/span><span>last_name<\/span><span>company<\/span><span>create_date_utc<\/span><span>contact_id<\/span><span>last_active_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>clicks.link_id<\/span><span>middle_name<\/span><span>website<\/span><span>job_title<\/span><span>telephone<\/span><span>telephone_ext<\/span><span>fax<\/span><span>mobile_number<\/span><span>home_number<\/span><span>address_1<\/span><span>address_2<\/span><span>address_3<\/span><span>address_4<\/span><span>city<\/span><span>county<\/span><span>postcode<\/span><span>country<\/span><span>opt_in<\/span><span>custom_1<\/span><span>custom_2<\/span><span>custom_3<\/span><span>custom_4<\/span><span>custom_5<\/span><span>custom_6<\/span><span>custom_7<\/span><span>custom_8<\/span><span>custom_9<\/span><span>custom_10<\/span><span>custom_11<\/span><span>custom_12<\/span><span>prefer_html<\/span><span>is_bounce<\/span><span>salesforce_account_id<\/span><span>salesforce_owner_id<\/span><span>unique_user_id<\/span><span>salesforce_id<\/span><span>siebel_id<\/span><span>dynamics_id<\/span><span>contact_guid<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/campaigns\/[campaign_id]\/clicks\/contacts\/[identifier]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contact\": {\r\n    \"contact_id\": 0,\r\n    \"email\": \"string\",\r\n    \"title\": \"string\",\r\n    \"first_name\": \"string\",\r\n    \"last_name\": \"string\",\r\n    \"company\": \"string\",\r\n    \"create_date_utc\": \"2017-05-17T11:09:07Z\",\r\n    \"last_active_utc\": \"2021-01-05T15:24:14Z\",\r\n    \"clicks\": [\r\n      {\r\n        \"click_date_utc\": \"2020-12-03T15:40:26Z\",\r\n\t\"url\": \"string\",\r\n        \"device\": {\r\n          \"name\": \"string\",\r\n          \"type\": \"string\"\r\n        }\r\n      }\r\n    ]\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getcampaignlinks\">Get campaign links<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/campaigns\/{campaign_id}\/links<\/span><\/div>\n<p>Get links for a specified campaign.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">campaign_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot campaign id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>link_id<\/span><span>url<\/span><span>tracked_url<\/span><span>type<\/span><span>total_clicks<\/span><span>unique_clicks<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>tags.tag_id<\/span><span>tags.name<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 1000; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is link_id descending.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/campaigns\/[campaign_id]\/links\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"links\": [\r\n    {\r\n      \"link_id\": 0,\r\n      \"url\": \"string\",\r\n      \"tracked_url\": \"string\",\r\n      \"type\": \"string\",\r\n      \"total_clicks\": 0,\r\n      \"unique_clicks\": 0\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getcampaignunsubscribes\">Get campaign unsubscribes<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/campaigns\/{campaign_id}\/unsubscribes<\/span><\/div>\n<p>Get unsubscribes for a specified campaign.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">campaign_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot campaign id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>unsubscribe_date_utc<\/span><span>contact.email<\/span><span>contact.title<\/span><span>contact.first_name<\/span><span>contact.last_name<\/span><span>contact.company<\/span><span>contact.create_date_utc<\/span><span>contact.contact_id<\/span><span>contact.last_active_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>contact.middle_name<\/span><span>contact.website<\/span><span>contact.job_title<\/span><span>contact.telephone<\/span><span>contact.telephone_ext<\/span><span>contact.fax<\/span><span>contact.mobile_number<\/span><span>contact.home_number<\/span><span>contact.address_1<\/span><span>contact.address_2<\/span><span>contact.address_3<\/span><span>contact.address_4<\/span><span>contact.city<\/span><span>contact.county<\/span><span>contact.postcode<\/span><span>contact.country<\/span><span>contact.opt_in<\/span><span>contact.custom_1<\/span><span>contact.custom_2<\/span><span>contact.custom_3<\/span><span>contact.custom_4<\/span><span>contact.custom_5<\/span><span>contact.custom_6<\/span><span>contact.custom_7<\/span><span>contact.custom_8<\/span><span>contact.custom_9<\/span><span>contact.custom_10<\/span><span>contact.custom_11<\/span><span>contact.custom_12<\/span><span>contact.prefer_html<\/span><span>contact.is_bounce<\/span><span>contact.salesforce_account_id<\/span><span>contact.salesforce_owner_id<\/span><span>contact.unique_user_id<\/span><span>contact.salesforce_id<\/span><span>contact.siebel_id<\/span><span>contact.dynamics_id<\/span><span>contact.contact_guid<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 1000; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is unsubscribe_date_utc descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">contact_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on a unique StoneShot contact id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact email address.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">first_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact first name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">last_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact last name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">company<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact company.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">job_title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact job title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">city<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact city.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">county<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact county.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">country<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact country.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact salesforce id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact siebel id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">dynamics_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact microsoft dynamics id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact unique external user id.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/campaigns\/[campaign_id]\/unsubscribes\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"unsubscribes\": [\r\n    {\r\n      \"unsubscribe_date_utc\": \"2019-06-13T15:00:45Z\",\r\n      \"contact\": {\r\n\t\"contact_id\": 0,\r\n        \"email\": \"string\",\r\n        \"title\": \"string\",\r\n        \"first_name\": \"string\",\r\n        \"last_name\": \"string\",\r\n        \"company\": \"string\",\r\n        \"create_date_utc\": \"2020-10-07T19:03:11Z\",\r\n        \"last_active_utc\": \"2020-12-22T16:29:30Z\"\r\n      }\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"addcontacttocampaign\">Add contact to campaign<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">PATCH<\/span><span class=\"request-code\">\/campaigns\/{campaign_id}\/contacts<\/span><\/div>\n<p>Send a contact an email by adding them to an existing campaign using any of the unique contact ids.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">campaign_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot campaign id.<\/div>\n<\/div><\/div>\n<h5>Body parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">member_url_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact member url (optional)<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact salesforce id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">dynamics_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact microsoft dynamics id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact siebel id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact unique external user id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">contact_id<\/span><span class=\"parameter-type\">integer<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot contact id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact email address (optional).<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X PATCH \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/campaigns\/[campaign_id]\/contacts\"\r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\" \\\r\n\t-H \"Content-Type: application\/JSON\" \\\r\n  -d '{\"email\": \"string\"}'\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contacts\": [\r\n    {\r\n      \"contact_id\": 0,\r\n      \"email\": \"string\",\r\n      \"title\": \"string\",\r\n      \"first_name\": \"string\",\r\n      \"last_name\": \"string\",\r\n      \"company\": \"string\",\r\n      \"create_date_utc\": \"2019-06-13T15:00:45Z\",\r\n      \"last_active_utc\": \"2020-08-06T15:03:10Z\"\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"contacts\" class=\"section\">\n<h3>Contacts<\/h3>\n<p>Retrieve your StoneShot contacts information, create or update contacts and more.<\/p>\n<div class=\"method\">\n<h4 id=\"getcontacts\">Get contacts<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/contacts<\/span><\/div>\n<p>Retrieve contacts associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Request parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>email<\/span><span>title<\/span><span>first_name<\/span><span>last_name<\/span><span>company<\/span><span>create_date_utc<\/span><span>contact_id<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>middle_name<\/span><span>website<\/span><span>job_title<\/span><span>telephone<\/span><span>telephone_ext<\/span><span>fax<\/span><span>mobile_number<\/span><span>home_number<\/span><span>address_1<\/span><span>address_2<\/span><span>address_3<\/span><span>address_4<\/span><span>city<\/span><span>county<\/span><span>postcode<\/span><span>country<\/span><span>opt_in<\/span><span>custom_1<\/span><span>custom_2<\/span><span>custom_3<\/span><span>custom_4<\/span><span>custom_5<\/span><span>custom_6<\/span><span>custom_7<\/span><span>custom_8<\/span><span>custom_9<\/span><span>custom_10<\/span><span>custom_11<\/span><span>custom_12<\/span><span>prefer_html<\/span><span>create_date_utc<\/span><span>is_bounce<\/span><span>salesforce_account_id<\/span><span>salesforce_owner_id<\/span><span>double_opt_in_status<\/span><span>unique_user_id<\/span><span>salesforce_id<\/span><span>siebel_id<\/span><span>dynamics_id<\/span><span>segments.segment_id<\/span><span>segments.name<\/span><span>segments.segmentation.name<\/span><span>segments.segmentation.segmentation_id<\/span><span>email_preferences.segment_id<\/span><span>email_preferences.name<\/span><span>email_preferences.segmentation.name<\/span><span>email_preferences.segmentation.segmentation_id<\/span><span>content_preferences.content_tag_id<\/span><span>content_preferences.tag.tag_id<\/span><span>content_preferences.tag.name<\/span><span>events.segment_id<\/span><span>events.name<\/span><span>events.segmentation.name<\/span><span>events.segmentation.segmentation_id<\/span><span>events.session.session_id<\/span><span>events.session.location<\/span><span>events.session.event.event_id<\/span><span>events.session.event.name<\/span><span>document_preferences.segment_id<\/span><span>document_preferences.name<\/span><span>document_preferences.segmentation.name<\/span><span>document_preferences.segmentation.segmentation_id<\/span><br \/>\n\t\t\t\t\t\t\t\t\t<span>custom_fields.value<\/span><span>custom_fields.custom_field.custom_field_id<\/span><span>custom_fields.custom_field.name<\/span><span>custom_fields.custom_field.display_name<\/span><span>contact_guid<\/span><span>last_active_utc<\/span><span>last_update_date_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is contact_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on the email address.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on the title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">first_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on the first name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">last_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on the last name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">company<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on the company.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">job_title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on the job title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">city<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on the city.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">county<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on the county.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">country<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on the country.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">last_update_date_utc<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Only retrieve contacts that have been updated on or before this date. Provide in the following format: \u201cyyyy-MM-ddTHH:mm:ss.fffZ\u201d.<\/div>\n<\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/contacts\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"  \r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contacts\": [\r\n    {\r\n      \"contact_id\": 0,\r\n      \"email\": \"string\",\r\n      \"title\": \"string\",\r\n      \"first_name\": \"string\",\r\n      \"last_name\": \"string\",\r\n      \"company\": \"string\",\r\n      \"create_date_utc\": \"2020-01-09T15:12:17Z\"\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"createcontact\">Create contact<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">POST<\/span><span class=\"request-code\">\/contacts<\/span><\/div>\n<p>Create a new contact against your account.<\/p>\n<div class=\"method-detail\">\n<h5>Body parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The email address of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">title<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The title of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">first_name<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The first name of the contact <\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">last_name<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The last name of the contact<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">job_title<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The job title of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">company<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The company of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">opt_in<\/span><span class=\"parameter-type\">boolean<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The opt-in status of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">prefer_html<\/span><span class=\"parameter-type\">boolean<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The preferred email format for the contact to receive.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">address_1<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The address line 1 of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">address_2<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The address line 2 of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">address_3<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The address line 3 of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">address_4<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The address line 4 of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">city<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The city of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">county<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The county of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">country<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The country of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">postcode<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The postcode of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">telephone<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The telephone of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">telephone_ext<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The telephone extension of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">mobile_number<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The mobile telephone number of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">home_number<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The home telephone number of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">fax<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The fax number of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">website<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The website of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The external unique user id of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The salesforce id of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The siebel id of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">microsoft_dynamics_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The microsoft dynamics id of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">custom_1<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The custom 1 of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">segmentations<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The segmentation values for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email_preferences<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The email preference values for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">events<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The event session statuses for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">document_preferences<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The document preference values for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">content_preferences<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The content preference values for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">custom_fields<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The custom field values for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">double_opt_in_status<\/span><span class=\"parameter-type\">integer<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The double opt-in status of the contact.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X POST \\\r\n\t\"https:\/\/api.stoneshot.com\/v1\/contacts\" \\\r\n\t-H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\" \\\r\n\t-H \"Content-Type: application\/JSON\" \\\r\n\t-d '{\"email\": \"string\", \"first_name\": \"string\", \"last_name\": \"string\", \"segmentations\": [{ \"segmentation_id\": integer, \"segment_id\": integer }], \"email_preferences\": [{ \"segmentation_id\": integer, \"segment_id\": integer }], \"events\": [{ \"segmentation_id\": integer, \"segment_id\": integer }] , \"document_preferences\": [{ \"segmentation_id\": integer, \"segment_id\": integer }], \"content_preferences\": [{ \"tag_id\": integer }], \"custom_fields\": [{ \"custom_field_id\": integer, \"value\": \"string\" }]}'\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contact\": {\r\n    \"contact_id\": 0,\r\n    \"email\": \"string\",\r\n    \"title\": \"string\",\r\n    \"first_name\": \"string\",\r\n    \"last_name\": \"string\",\r\n    \"company\": \"string\",\r\n    \"create_date_utc\": \"2020-01-09T15:12:17Z\",\r\n    \"last_active_utc\": \"2020-01-09T15:12:17Z\"\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"119\",\r\n  \"message\": \"Invalid email address\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getcontact\">Get contact<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/contacts\/{identifier}<\/span><\/div>\n<p>Get information for a specific contact record in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">identifier<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">A unique identifier for the contact. See <a class=\"matching-anchor\" href=\"#contactmatching\">contact matching<\/a> for a list of the supported identifiers.<\/div>\n<\/div><\/div>\n<h5>Request parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>email<\/span><span>title<\/span><span>first_name<\/span><span>last_name<\/span><span>company<\/span><span>create_date_utc<\/span><span>contact_id<\/span><span>last_active_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>middle_name<\/span><span>website<\/span><span>job_title<\/span><span>telephone<\/span><span>telephone_ext<\/span><span>fax<\/span><span>mobile_number<\/span><span>home_number<\/span><span>address_1<\/span><span>address_2<\/span><span>address_3<\/span><span>address_4<\/span><span>city<\/span><span>county<\/span><span>postcode<\/span><span>country<\/span><span>opt_in<\/span><span>custom_1<\/span><span>custom_2<\/span><span>custom_3<\/span><span>custom_4<\/span><span>custom_5<\/span><span>custom_6<\/span><span>custom_7<\/span><span>custom_8<\/span><span>custom_9<\/span><span>custom_10<\/span><span>custom_11<\/span><span>custom_12<\/span><span>prefer_html<\/span><span>create_date_utc<\/span><span>is_bounce<\/span><span>salesforce_account_id<\/span><span>salesforce_owner_id<\/span><span>double_opt_in_status<\/span><span>unique_user_id<\/span><span>salesforce_id<\/span><span>siebel_id<\/span><span>dynamics_id<\/span><span>segments.segment_id<\/span><span>segments.name<\/span><span>segments.segmentation.name<\/span><span>segments.segmentation.segmentation_id<\/span><span>email_preferences.segment_id<\/span><span>email_preferences.name<\/span><span>email_preferences.segmentation.name<\/span><span>email_preferences.segmentation.segmentation_id<\/span><span>content_preferences.content_tag_id<\/span><span>content_preferences.tag.tag_id<\/span><span>content_preferences.tag.name<\/span><span>events.segment_id<\/span><span>events.name<\/span><span>events.segmentation.name<\/span><span>events.segmentation.segmentation_id<\/span><span>events.session.session_id<\/span><span>events.session.location<\/span><span>events.session.event.event_id<\/span><span>events.session.event.name<\/span><span>document_preferences.segment_id<\/span><span>document_preferences.name<\/span><span>document_preferences.segmentation.name<\/span><span>document_preferences.segmentation.segmentation_id<\/span><br \/>\n\t\t\t\t\t\t\t\t\t<span>custom_fields.value<\/span><span>custom_fields.custom_field.custom_field_id<\/span><span>custom_fields.custom_field.name<\/span><span>custom_fields.custom_field.display_name<\/span><span>contact_guid<\/span><span>last_update_date_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/contacts\/[identifier]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"  \r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contact\": {\r\n    \"contact_id\": 0,\r\n    \"email\": \"string\",\r\n    \"title\": \"string\",\r\n    \"first_name\": \"string\",\r\n    \"last_name\": \"string\",\r\n    \"company\": \"string\",\r\n    \"create_date_utc\": \"2020-01-09T15:12:17Z\",\r\n    \"last_active_utc\": \"2020-01-09T15:12:17Z\"\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"updatecontact\">Update contact<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">PATCH<\/span><span class=\"request-code\">\/contacts\/{identifier}<\/span><\/div>\n<p>Update a contact record in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">identifier<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">A unique identifier for the contact. See <a class=\"matching-anchor\" href=\"#contactmatching\">contact matching<\/a> for a list of the supported identifiers.<\/div>\n<\/div><\/div>\n<h5>Body parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The email address of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">title<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The title of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">first_name<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The first name of the contact <\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">last_name<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The last name of the contact<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">job_title<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The job title of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">company<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The company of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">opt_in<\/span><span class=\"parameter-type\">boolean<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The opt-in status of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">prefer_html<\/span><span class=\"parameter-type\">boolean<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The preferred email format for the contact to receive.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">address_1<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The address line 1 of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">address_2<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The address line 2 of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">address_3<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The address line 3 of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">address_4<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The address line 4 of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">city<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The city of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">county<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The county of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">country<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The country of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">postcode<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The postcode of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">telephone<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The telephone of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">telephone_ext<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The telephone extension of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">mobile_number<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The mobile telephone number of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">home_number<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The home telephone number of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">fax<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The fax number of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">website<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The website of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The external unique user id of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The salesforce id of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The siebel id of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">microsoft_dynamics_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The microsoft dynamics id of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">custom_1<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The custom 1 of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">segmentations<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The segmentation values for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email_preferences<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The email preference values for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">events<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The event session statuses for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">document_preferences<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The document preference values for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">content_preferences<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The content preference values for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">custom_fields<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The custom field values for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">double_opt_in_status<\/span><span class=\"parameter-type\">integer<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The double opt-in status of the contact.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X PATCH \\\r\n\t\"https:\/\/api.stoneshot.com\/v1\/contacts\/[identifier]\" \\\r\n\t-H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\" \\\r\n\t-H \"Content-Type: application\/JSON\" \\\r\n\t-d '{\"email\": \"string\", \"first_name\": \"string\", \"last_name\": \"string\", \"segmentations\": [{ \"segmentation_id\": integer, \"segment_id\": integer }], \"email_preferences\": [{ \"segmentation_id\": integer, \"segment_id\": integer }], \"events\": [{ \"segmentation_id\": integer, \"segment_id\": integer }] , \"document_preferences\": [{ \"segmentation_id\": integer, \"segment_id\": integer }], \"content_preferences\": [{ \"tag_id\": integer }], \"custom_fields\": [{ \"custom_field_id\": integer, \"value\": \"string\" }]}'\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contact\": {\r\n    \"contact_id\": 0,\r\n    \"email\": \"string\",\r\n    \"title\": \"string\",\r\n    \"first_name\": \"string\",\r\n    \"last_name\": \"string\",\r\n    \"company\": \"string\",\r\n    \"create_date_utc\": \"2020-01-09T15:12:17Z\",\r\n    \"last_active_utc\": \"2020-01-09T15:12:17Z\"\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"create-or-updatecontact\">Create or Update contact<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">POST<\/span><span class=\"request-code\">\/contacts\/createOrUpdate<\/span><\/div>\n<p>Create a new contact against your account, or update if that contact already exists, based on email address.<\/p>\n<div class=\"method-detail\">\n<h5>Body parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The email address of the contact. <strong>(Required)<\/strong><\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">title<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The title of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">first_name<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The first name of the contact <\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">last_name<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The last name of the contact<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">job_title<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The job title of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">company<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The company of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">opt_in<\/span><span class=\"parameter-type\">boolean<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The opt-in status of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">prefer_html<\/span><span class=\"parameter-type\">boolean<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The preferred email format for the contact to receive.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">address_1<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The address line 1 of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">address_2<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The address line 2 of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">address_3<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The address line 3 of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">address_4<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The address line 4 of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">city<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The city of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">county<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The county of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">country<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The country of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">postcode<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The postcode of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">telephone<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The telephone of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">telephone_ext<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The telephone extension of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">mobile_number<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The mobile telephone number of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">home_number<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The home telephone number of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">fax<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The fax number of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">website<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The website of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The external unique user id of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The salesforce id of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The siebel id of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">microsoft_dynamics_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The microsoft dynamics id of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">custom_1<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The custom 1 of the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">segmentations<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The segmentation values for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email_preferences<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The email preference values for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">events<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The event session statuses for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">document_preferences<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The document preference values for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">content_preferences<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The content preference values for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">custom_fields<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The custom field values for the contact.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">double_opt_in_status<\/span><span class=\"parameter-type\">integer<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The double opt-in status of the contact.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X POST \\\r\n\t\"https:\/\/api.stoneshot.com\/v1\/contacts\/createOrUpdate\" \\\r\n\t-H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\" \\\r\n\t-H \"Content-Type: application\/JSON\" \\\r\n\t-d '{\"email\": \"string\", \"first_name\": \"string\", \"last_name\": \"string\", \"segmentations\": [{ \"segmentation_id\": integer, \"segment_id\": integer }], \"email_preferences\": [{ \"segmentation_id\": integer, \"segment_id\": integer }], \"events\": [{ \"segmentation_id\": integer, \"segment_id\": integer }] , \"document_preferences\": [{ \"segmentation_id\": integer, \"segment_id\": integer }], \"content_preferences\": [{ \"tag_id\": integer }], \"custom_fields\": [{ \"custom_field_id\": integer, \"value\": \"string\" }]}'\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contact\": {\r\n    \"contact_id\": 0,\r\n    \"email\": \"string\",\r\n    \"title\": \"string\",\r\n    \"first_name\": \"string\",\r\n    \"last_name\": \"string\",\r\n    \"company\": \"string\",\r\n    \"create_date_utc\": \"2020-01-09T15:12:17Z\",\r\n    \"last_active_utc\": \"2020-01-09T15:12:17Z\"\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"119\",\r\n  \"message\": \"Invalid email address\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getcampaignactivity\">Get contact campaign activity<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/campaigns\/activity\/contacts\/{identifier}<\/span><\/div>\n<p>Retrieve all historic campaign activity for a contact associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">identifier<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">A unique identifier for the contact. See <a class=\"matching-anchor\" href=\"#contactmatching\">contact matching<\/a> for a list of the supported identifiers.<\/div>\n<\/div><\/div>\n<h5>Request parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>email<\/span><span>title<\/span><span>first_name<\/span><span>last_name<\/span><span>company<\/span><span>create_date_utc<\/span><span>contact_id<\/span><span>last_active_utc<\/span><span>campaign_activity.activity_date_utc<\/span><span>campaign_activity.type<\/span><span>campaign_activity.campaign.campaign_id<\/span><span>campaign_activity.campaign.name<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>middle_name<\/span><span>website<\/span><span>job_title<\/span><span>telephone<\/span><span>telephone_ext<\/span><span>fax<\/span><span>mobile_number<\/span><span>home_number<\/span><span>address_1<\/span><span>address_2<\/span><span>address_3<\/span><span>address_4<\/span><span>city<\/span><span>county<\/span><span>postcode<\/span><span>country<\/span><span>opt_in<\/span><span>custom_1<\/span><span>custom_2<\/span><span>custom_3<\/span><span>custom_4<\/span><span>custom_5<\/span><span>custom_6<\/span><span>custom_7<\/span><span>custom_8<\/span><span>custom_9<\/span><span>custom_10<\/span><span>custom_11<\/span><span>custom_12<\/span><span>prefer_html<\/span><span>is_bounce<\/span><span>salesforce_account_id<\/span><span>salesforce_owner_id<\/span><span>double_opt_in_status<\/span><span>unique_user_id<\/span><span>salesforce_id<\/span><span>siebel_id<\/span><span>dynamics_id<\/span><span>campaign_activity.campaign.date_sent_utc<\/span><span>campaign_activity.campaign.from_name<\/span><span>campaign_activity.campaign.from_email<\/span><span>campaign_activity.campaign.subject<\/span><span>campaign_activity.activity_id<\/span><span>campaign_activity.url_clicked<\/span><span>campaign_activity.read_seconds<\/span><span>contact_guid<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">campaign_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on campaign ID.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">campaign_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on campaign name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">tag<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on campaigns with a given tag.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">from_date_utc<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Only retrieve activity that occurred on or after this date. Provide in the following format: &#8220;yyyy-MM-ddTHH:mm:ss.fffZ&#8221;.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">to_date_utc<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Only retrieve activity that occurred on or before this date. Provide in the following format: &#8220;yyyy-MM-ddTHH:mm:ss.fffZ&#8221;.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/campaigns\/activity\/contacts\/[identifier]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"  \r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contact\": [\r\n    {\r\n      \"contact_id\": 0,\r\n      \"email\": \"string\",\r\n      \"title\": \"string\",\r\n      \"first_name\": \"string\",\r\n      \"last_name\": \"string\",\r\n      \"company\": \"string\",\r\n      \"create_date_utc\": \"2020-01-09T15:12:17Z\",\r\n      \"last_active_utc\": \"2020-01-09T15:12:17Z\",\r\n      \"campaign_activity\": [\r\n        {\r\n\t  \"activity_date_utc\": \"2020-01-09T15:12:17Z\",\r\n\t  \"type\": \"string\",\r\n\t  \"campaign\": {\r\n\t    \"campaign_id\": 0,\r\n\t    \"name\": \"string\"\r\n\t  }\r\n        }\r\n      ]\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"contentdistributionsystem\" class=\"section\">\n<h3>Content distribution system<\/h3>\n<p>Your StoneShot content preferences, used for managing contact content preferences.<\/p>\n<div class=\"method\">\n<h4 id=\"getcontentpreferences\">Get content preferences<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/content-preferences<\/span><\/div>\n<p>Retrieve all content preferences against your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>content_tag_id<\/span><span>display_order<\/span><span>tag.tag_id<\/span><span>tag.name<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>enabled<\/span><span>visible<\/span><span>group_id<\/span><span>description<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the content preference name.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/content-preferences\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"content_preferences\": [\r\n    {\r\n      \"content_tag_id\": 0,      \r\n      \"display_order\": 0,\r\n      \"tag\": {\r\n        \"tag_id\": 0,\r\n        \"name\": \"string\"\r\n      }\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getcontentpreference\">Get content preference<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/content-preferences\/{content_tag_id}<\/span><\/div>\n<p>Get information for a specific content preference in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">content_tag_id<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">The unique StoneShot content tag id.<\/div>\n<\/div><\/div>\n<h5>Request parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>content_tag_id<\/span><span>display_order<\/span><span>tag.tag_id<\/span><span>tag.name<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>enabled<\/span><span>visible<\/span><span>group_id<\/span><span>description<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/content-preferences\/[content_tag_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"  \r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"content_preference\": {\r\n    \"content_tag_id\": 0,\r\n    \"display_order\": 0,\r\n    \"tag\": {\r\n      \"tag_id\": 0,\r\n      \"name\": \"string\"\r\n    }\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"updatecontentpreference\">Update content preference<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">PATCH<\/span><span class=\"request-code\">\/content-preferences\/{content_tag_id}<\/span><\/div>\n<p>Update a content tag preference in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">content_tag_id<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">The unique StoneShot content tag id.<\/div>\n<\/div><\/div>\n<h5>Body parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">name<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">The name of the content tag preference.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X PATCH \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/content-preferences\/[content_tag_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\" \\\r\n\t-H \"Content-Type: application\/JSON\" \\\r\n  -d '{\"name\": \"string\"}'\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"content_preference\": {\r\n    \"content_tag_id\": 0,\r\n    \"display_order\": 0,\r\n    \"tag\": {\r\n      \"tag_id\": 0,\r\n      \"name\": \"string\"\r\n    }\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"122\",\r\n  \"message\": \"That record already exists\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"contactcustomfields\" class=\"section\">\n<h3>Contact custom fields<\/h3>\n<p>Your StoneShot contact custom fields, used for storing custom contact information.<\/p>\n<div class=\"method\">\n<h4 id=\"getcontactcustomfields\">Get contact custom fields<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/custom-fields<\/span><\/div>\n<p>Retrieve all contact custom fields against your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>custom_field_id<\/span><span>name<\/span><span>display_name<\/span><span>display_order<\/span><span>created_at_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>allow_html<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the custom field name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">display_name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the custom field display name.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/custom-fields\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"custom_fields\": [\r\n    {\r\n      \"custom_field_id\": 0,\r\n      \"name\": \"string\",\r\n      \"display_name\": \"string\",\t         \r\n      \"display_order\": 0,\r\n      \"created_at_utc\": \"2020-01-17:43:25Z\"      \r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"documentdistributionsystem\" class=\"section\">\n<h3>Document distribution system<\/h3>\n<p>Your StoneShot fund document preferences, used for managing contact fund document preferences.<\/p>\n<div class=\"method\">\n<h4 id=\"getdocumentpreferences\">Get document preferences<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/document-preferences<\/span><\/div>\n<p>Retrieve all document preferences against your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>document_fund_id<\/span><span>name<\/span><span>range.range_id<\/span><span>range.name<\/span><span>documents.document_id<\/span><span>documents.external_id<\/span><span>documents.name<\/span><span>documents.url<\/span><span>documents.last_updated_utc<\/span><span>documents.subscribed_id<\/span><span>documents.unsubscribed_id<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>alt_name<\/span><span>documents.system_name<\/span><span>documents.segmentation_id<\/span><span>documents.isin<\/span><span>documents.sedol<\/span><span>documents.alt_name<\/span><span>documents.description<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is document_fund_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the document fund name.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/document-preferences\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"document_preferences\": [\r\n    {\r\n      \"document_fund_id\": 2510,\r\n      \"name\": \"PAICR_2018\",\r\n      \"url\": null,\r\n      \"subscribed_id\": null,\r\n      \"unsubscribed_id\": null,\r\n      \"last_updated_utc\": \"2018-09-27T15:27:25Z\",\r\n      \"range\": null,\r\n      \"documents\": [\r\n        {\r\n          \"document_id\": 11446,\r\n          \"name\": \"StoneShot_MA-TheGood-TheBad-TheUgly_BOSTON\",\r\n          \"url\": \"\",\r\n          \"last_updated_utc\": \"2018-09-27T15:26:38Z\",\r\n          \"external_id\": null,\r\n          \"subscribed_id\": 457506,\r\n          \"unsubscribed_id\": 457507\r\n        }\r\n      ]\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"emailpreferences\" class=\"section\">\n<h3>Email preferences<\/h3>\n<p>Your StoneShot email preferences, used for managing contact preferences.<\/p>\n<div class=\"method\">\n<h4 id=\"getemailpreferences\">Get email preferences<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/email-preferences<\/span><\/div>\n<p>Retrieve all email preferences against your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t<span>segmentation_id<\/span><span>name<\/span><span>display_order<\/span><span>segments.segment_id<\/span><span>segments.name<\/span><span>segments.display_order<\/span>\n\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t<span>dynamic_system_name<\/span><span>segments.details<\/span><span>segments.dynamic_from_email<\/span><span>segments.dynamic_from_name<\/span>\n\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is segmentation_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the email preference name.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/email-preferences\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"email_preferences\": [\r\n    {\r\n      \"segmentation_id\": 0,\r\n      \"name\": \"string\",      \r\n      \"display_order\": 0,\r\n      \"segments\": [\r\n        {\r\n          \"segment_id\": 0,          \r\n          \"name\": \"string\",\r\n          \"display_order\": 0\r\n        },\r\n        {\r\n          \"segment_id\": 0,          \r\n          \"name\": \"string\",\r\n          \"display_order\": 0\r\n        }\r\n      ]\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getemailpreference\">Get email preference<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/email-preferences\/{segmentation_id}<\/span><\/div>\n<p>Get information for a specific email preference in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">segmentation_id<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">The unique StoneShot email preference id.<\/div>\n<\/div><\/div>\n<h5>Request parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>segmentation_id<\/span><span>name<\/span><span>display_order<\/span><span>segments.segment_id<\/span><span>segments.name<\/span><span>segments.display_order<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>dynamic_system_name<\/span><span>segments.details<\/span><span>segments.dynamic_from_email<\/span><span>segments.dynamic_from_name<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/email-preferences\/[segmentation_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"  \r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  {\r\n    \"email_preference\": {\r\n      \"segmentation_id\": 0,\r\n      \"name\": \"string\",\r\n      \"display_order\": 0,\r\n      \"segments\": [\r\n        {\r\n          \"segment_id\": 0,\r\n          \"name\": \"string\",\r\n          \"display_order\": 0\r\n        }\r\n      ]\r\n    }\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"updateemailpreference\">Update email preference<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">PATCH<\/span><span class=\"request-code\">\/email-preferences\/{segmentation_id}<\/span><\/div>\n<p>Update an email preference in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">segmentation_id<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">The unique StoneShot email preference id.<\/div>\n<\/div><\/div>\n<h5>Body parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">name<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">The name of the email preference.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X PATCH \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/email-preferences\/[segmentation_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\" \\\r\n\t-H \"Content-Type: application\/JSON\" \\\r\n  -d '{\"name\": \"string\"}'\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  {\r\n    \"email_preference\": {\r\n      \"segmentation_id\": 0,\r\n      \"name\": \"string\",\r\n      \"display_order\": 0,\r\n      \"segments\": [\r\n        {\r\n          \"segment_id\": 0,\r\n          \"name\": \"string\",\r\n          \"display_order\": 0\r\n        }\r\n      ]\r\n    }\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"122\",\r\n  \"message\": \"That record already exists\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"events\" class=\"section\">\n<h3>Events<\/h3>\n<p>Your StoneShot events can be managed and queried.<\/p>\n<div class=\"method\">\n<h4 id=\"getevents\">Get events<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/events<\/span><\/div>\n<p>Retrieve events associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t                        <span>event_id<\/span><span>name<\/span><span>summary<\/span><span>description<\/span><span>create_date_utc<\/span><span>update_date_utc<\/span><span>teams.name<\/span><span>tags.name<\/span><span>custom_fields.custom_field_id<\/span><span>custom_fields.display_name<\/span>\n\t\t\t                    <\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t                        <span>type<\/span><span>url<\/span><span>salesforce_campaign_id<\/span><span>teams.team_id<\/span><span>tags.tag_id<\/span><span>custom_fields.name<\/span><span>custom_fields.order_by<\/span><span>start_date<\/span><span>end_date<\/span><span>sessions.segmentation_id<\/span><span>campaign_code<\/span>\n\t\t\t                    <\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is event_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the event name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">tag<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on events with a given tag.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">team<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on events with a given team.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/events\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"events\": [\r\n    {\r\n        \"name\": \"string\",\r\n        \"summary\": \"string\",\r\n        \"description\": \"string\",\r\n        \"create_date_utc\": \"2020-10-07T08:27:25Z\",\r\n        \"update_date_utc\": \"2020-10-07T08:27:25Z\",\r\n        \"tags\": [],\r\n        \"teams\": [],\r\n        \"custom_fields\": []\r\n    }\r\n  ]\r\n}\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getevent\">Get event<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/events\/{event_id}<\/span><\/div>\n<p>Get information about a specific event in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">event_id<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The unique StoneShot event id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>event_id<\/span><span>name<\/span><span>summary<\/span><span>description<\/span><span>create_date_utc<\/span><span>update_date_utc<\/span><span>teams.name<\/span><span>tags.name<\/span><span>custom_fields.custom_field_id<\/span><span>custom_fields.display_name<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>type<\/span><span>url<\/span><span>salesforce_campaign_id<\/span><span>teams.team_id<\/span><span>tags.tag_id<\/span><span>custom_fields.name<\/span><span>custom_fields.order_by<\/span><span>start_date<\/span><span>end_date<\/span><span>sessions.segmentation_id<\/span><span>campaign_code<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/events\/[event_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"event\": {\r\n    \"name\": \"string\",\r\n    \"summary\": \"string\",\r\n    \"description\": \"string\",\r\n    \"create_date_utc\": \"2020-06-23T16:12:18Z\",\r\n    \"update_date_utc\": \"2020-06-23T16:12:18Z\",\r\n    \"tags\": [],\r\n    \"teams\": [],\r\n    \"custom_fields\": []\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getsessions\">Get event sessions<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/events\/{event_id}\/sessions<\/span><\/div>\n<p>Retrieve sessions in an event associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">event_id<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The unique StoneShot event id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t                        <span>session_id<\/span><span>location<\/span><span>description<\/span><span>start_date<\/span><span>tags.name<\/span><span>custom_field_values.custom_field_id<\/span><span>custom_field_values.text_content<\/span><span>statuses.name<\/span><span>statuses.count<\/span><span>statuses.segment_id<\/span><span>venue.venue_id<\/span><span>venue.name<\/span><span>venue.city<\/span><span>speaker.speaker_id<\/span><span>speaker.name<\/span><span>speaker.location<\/span><span>agenda.name<\/span><span>agenda.timeslot<\/span><span>moderator.speaker_id<\/span><span>moderator.name<\/span><span>moderator.location<\/span>\n\t\t\t                    <\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t                        <span>end_date<\/span><span>arrive_date<\/span><span>salesforce_campaign_id<\/span><span>tags.tag_id<\/span><span>segmentation_id<\/span>\n\t\t\t                    <\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is session_id descending.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/events\/[event_id]\/sessions\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"sessions\": [\r\n    {\r\n      \"location\": \"string\",\r\n      \"description\": \"string\",\r\n      \"start_date\": \"2020-10-07T08:27:25\",\r\n      \"custom_field_values\": [],\r\n      \"tags\": [],\r\n      \"statuses\": [],\r\n      \"venue\": [],\r\n      \"speaker\": [],\r\n      \"moderator\": [],\r\n      \"agenda\": []\r\n    }\r\n  ]\r\n}\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getsession\">Get event session<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/events\/{event_id}\/sessions\/{session_id}<\/span><\/div>\n<p>Get information about a specific session in an event in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">event_id<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The unique StoneShot event id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">session_id<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The unique StoneShot session id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t                        <span>session_id<\/span><span>location<\/span><span>description<\/span><span>start_date<\/span><span>tags.name<\/span><span>custom_field_values.custom_field_id<\/span><span>custom_field_values.text_content<\/span><span>statuses.name<\/span><span>statuses.count<\/span><span>statuses.segment_id<\/span><span>venue.venue_id<\/span><span>venue.name<\/span><span>venue.city<\/span><span>speaker.speaker_id<\/span><span>speaker.name<\/span><span>speaker.location<\/span><span>agenda.name<\/span><span>agenda.timeslot<\/span><span>moderator.speaker_id<\/span><span>moderator.name<\/span><span>moderator.location<\/span>\n\t\t\t                    <\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t                        <span>end_date<\/span><span>arrive_date<\/span><span>salesforce_campaign_id<\/span><span>tags.tag_id<\/span><span>segmentation_id<\/span>\n\t\t\t                    <\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/events\/[event_id]\/sessions\/[session_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"session\": {\r\n    \"location\": \"string\",\r\n    \"description\": \"string\",\r\n    \"start_date\": \"2020-06-23T16:12:18\",\r\n    \"custom_field_values\": [],\r\n    \"tags\": [],\r\n    \"statuses\": [],\r\n    \"venue\": [],\r\n    \"speaker\": [],\r\n    \"moderator\": [],\r\n    \"agenda\": []\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getsessioncontacts\">Get event session contacts<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/events\/{event_id}\/sessions\/{session_id}\/contacts<\/span><\/div>\n<p>Get contacts who are associated to a specific session in an event in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">event_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot event id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">session_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot session id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t                        <span>email<\/span><span>first_name<\/span><span>last_name<\/span><span>company<\/span><span>contact_id<\/span><span>status<\/span>\n\t\t\t                    <\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t                        <span>unique_user_id<\/span><span>salesforce_id<\/span><span>siebel_id<\/span><span>dynamics_id<\/span><span>contact_guid<\/span>\n\t\t\t                    <\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 1000; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is contact_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">contact_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on a unique StoneShot contact id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact email address.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">first_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact first name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">last_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact last name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">company<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact company.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact salesforce id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact siebel id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">dynamics_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact microsoft dynamics id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact unique external user id.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/events\/[event_id]\/sessions\/[session_id]\/contacts\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contacts\": [\r\n    {\r\n      \"contact_id\": 0,\r\n      \"email\": \"string\",\r\n      \"first_name\": \"string\",\r\n      \"last_name\": \"string\",\r\n      \"company\": \"string\",\r\n      \"status\": \"string\"\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getspeakers\">Get speakers<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/events\/speakers<\/span><\/div>\n<p>Retrieve event speakers associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t                        <span>speaker_id<\/span><span>name<\/span><span>job_title<\/span><span>location<\/span>\n\t\t\t                    <\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t                        <span>photo_url<\/span><span>description<\/span><span>profile_url<\/span>\n\t\t\t                    <\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is speaker_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the speaker name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">location<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on a location.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/events\/speakers\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"speakers\": [\r\n    {\r\n      \"name\": \"string\",\r\n      \"job_title\": \"string\",\r\n      \"location\": \"string\"\r\n    }\r\n  ]\r\n}\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getspeaker\">Get speaker<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/events\/speakers\/{speaker_id}<\/span><\/div>\n<p>Get information about a specific event speaker in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">speaker_id<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The unique StoneShot speaker id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t                        <span>speaker_id<\/span><span>name<\/span><span>job_title<\/span><span>location<\/span>\n\t\t\t                    <\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t                        <span>photo_url<\/span><span>description<\/span><span>profile_url<\/span>\n\t\t\t                    <\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/events\/speakers\/[speaker_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"speaker\": {\r\n    \"name\": \"string\",\r\n    \"job_title\": \"string\",\r\n    \"location\": \"string\"\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getvenues\">Get venues<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/events\/venues<\/span><\/div>\n<p>Retrieve event venues associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t                        <span>venue_id<\/span><span>name<\/span><span>address_1<\/span><span>address_2<\/span><span>address_3<\/span><span>address_4<\/span><span>city<\/span><span>country<\/span><span>postcode<\/span><span>capacity<\/span><span>overbook<\/span>\n\t\t\t                    <\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t                        <span>county<\/span><span>photo_url<\/span><span>map_url<\/span><span>email<\/span><span>telephone<\/span><span>contact<\/span><span>description<\/span><span>latitude<\/span><span>longitude<\/span>\n\t\t\t                    <\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is venue_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the venue name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">city<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on a city.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">country<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on a country.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/events\/venues\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"venues\": [\r\n    {\r\n      \"name\": \"string\",\r\n      \"address_1\": \"string\",\r\n      \"address_2\": \"string\",\r\n      \"address_3\": \"string\",\r\n      \"address_4\": \"string\",\r\n      \"city\": \"string\",\r\n      \"country\": \"string\",\r\n      \"postcode\": \"string\",\r\n      \"capacity\": 0,\r\n      \"overbook\": 0\r\n    }\r\n  ]\r\n}\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getvenue\">Get venue<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/events\/venues\/{venue_id}<\/span><\/div>\n<p>Get information about a specific event venue in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">venue_id<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The unique StoneShot venue id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>venue_id<\/span><span>name<\/span><span>address_1<\/span><span>address_2<\/span><span>address_3<\/span><span>address_4<\/span><span>city<\/span><span>country<\/span><span>postcode<\/span><span>capacity<\/span><span>overbook<\/span>\n\t\t\t                    <\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t                        <span>county<\/span><span>photo_url<\/span><span>map_url<\/span><span>email<\/span><span>telephone<\/span><span>contact<\/span><span>description<\/span><span>latitude<\/span><span>longitude<\/span>\n\t\t\t                    <\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/events\/venues\/[venue_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"venue\": {\r\n    \"name\": \"string\",\r\n    \"address_1\": \"string\",\r\n    \"address_2\": \"string\",\r\n    \"address_3\": \"string\",\r\n    \"address_4\": \"string\",\r\n    \"city\": \"string\",\r\n    \"country\": \"string\",\r\n    \"postcode\": \"string\",\r\n    \"capacity\": 0,\r\n    \"overbook\": 0\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"feeds\" class=\"section\">\n<h3>Feeds<\/h3>\n<p>Your StoneShot CDS feeds can be managed and queried.<\/p>\n<div class=\"method\">\n<h4 id=\"getarticles\">Get feed articles<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/feeds\/{feed_id}\/articles<\/span><\/div>\n<p>Retrieve articles in a feed associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">feed_id<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The unique StoneShot feed id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">category<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the category assigned.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>article_id<\/span><span>name<\/span><span>summary_html<\/span><span>body_html<\/span><span>url<\/span><span>image_url<\/span><span>update_date_utc<\/span><span>publish_date_utc<\/span><span>category<\/span><span>status<\/span><span>type<\/span><span>language<\/span><span>author<\/span><span>custom_field_values.custom_field_id<\/span><span>custom_field_values.text_content<\/span><span>tags.name<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>create_date_utc<\/span><span>timezone<\/span><span>tags.tag_id<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is article_id descending.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/feeds\/[feed_id]\/articles\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"articles\": [\r\n    {\r\n      \"name\": \"string\",\r\n      \"summary_html\": \"string\",\r\n      \"body_html\": \"string\",\r\n      \"url\": \"string\",\r\n      \"image_url\": \"string\",\r\n      \"update_date_utc\": \"2018-09-27T15:27:25Z\",\r\n      \"publish_date_utc\": \"2018-09-27T15:27:25Z\",\r\n      \"category\": \"string\",\r\n      \"status\": \"string\",\r\n      \"type\": \"string\",\r\n      \"language\": \"string\",\r\n      \"author\": \"string\",\r\n      \"custom_field_values\": [],\r\n      \"tags\": [],\r\n    }\r\n  ]\r\n}\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getarticle\">Get feed article<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/feeds\/{feed_id}\/articles\/{article_id}<\/span><\/div>\n<p>Get information about a specific article in a feed in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">feed_id<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The unique StoneShot feed id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">article_id<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The unique StoneShot article id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>article_id<\/span><span>name<\/span><span>summary_html<\/span><span>body_html<\/span><span>url<\/span><span>image_url<\/span><span>update_date_utc<\/span><span>publish_date_utc<\/span><span>category<\/span><span>status<\/span><span>type<\/span><span>language<\/span><span>author<\/span><span>custom_field_values.custom_field_id<\/span><span>custom_field_values.text_content<\/span><span>tags.name<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>create_date_utc<\/span><span>timezone<\/span><span>tags.tag_id<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/feeds\/[feed_id]\/articles\/[article_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"article\": [\r\n    {\r\n      \"name\": \"string\",\r\n      \"summary_html\": \"string\",\r\n      \"body_html\": \"string\",\r\n      \"url\": \"string\",\r\n      \"image_url\": \"string\",\r\n      \"update_date_utc\": \"2018-09-27T15:27:25Z\",\r\n      \"publish_date_utc\": \"2018-09-27T15:27:25Z\",\r\n      \"category\": \"string\",\r\n      \"status\": \"string\",\r\n      \"type\": \"string\",\r\n      \"language\": \"string\",\r\n      \"author\": \"string\",\r\n      \"custom_field_values\": [],\r\n      \"tags\": [],\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"files\" class=\"section\">\n<h3>Files<\/h3>\n<p>Your StoneShot files can be managed and queried.<\/p>\n<div class=\"method\">\n<h4 id=\"getfiles\">Get files<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/files<\/span><\/div>\n<p>Retrieve files associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>file_name<\/span><span>folder_name<\/span><span>file_type<\/span><span>size<\/span><span>url<\/span><span>create_date_utc<\/span><span>update_date_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 1000; maximum allowed value is 5000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is update_date_utc descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">file_name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the file name. The correct folder name must also be provided when filtering by file name, unless the file is located at the root, where it can be left empty.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">folder_name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the name of the folder that the file is located in. If no folder name is provided, files at the root will be returned.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/files\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"files\": [\r\n    {\r\n      \"file_name\": \"string\",\r\n      \"folder_name\": \"string\",\r\n      \"file_type\": \"string\",\r\n      \"size\": \"string\",\r\n      \"url\": \"string\",\r\n      \"create_date_utc\": \"2020-10-07T08:27:25Z\",\r\n      \"update_date_utc\": \"2020-10-07T08:27:25Z\"\r\n    }\r\n  ]\r\n}\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"uploadfile\">Upload file<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">POST<\/span><span class=\"request-code\">\/files<\/span><\/div>\n<p>Upload a file to your account.<\/p>\n<div class=\"method-detail\">\n<h5>Body parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">file<\/span><span class=\"parameter-type\">File<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">The file to be uploaded.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">folder_path<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">The folder path to upload your file to.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X POST \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/files\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\" \\\r\n\t-H \"Content-Type: application\/JSON\" \\\r\n  -F 'file=@\/path\/to\/file'\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"code\": \"100\",\r\n  \"message\": \"Success\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"128\",\r\n  \"message\": \"Invalid file type\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"forms\" class=\"section\">\n<h3>Forms<\/h3>\n<p>Your StoneShot forms can be managed and queried.<\/p>\n<div class=\"method\">\n<h4 id=\"getform\">Get form<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/forms\/{smart_form_ID}<\/span><\/div>\n<p>Get information for a specific form in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\"><span>smart_form_id<\/span><span>friendly_form_name<\/span><span>Url<\/span><span>create_date_utc<\/span><span>update_date_utc<\/span><span>tags.name<\/span><\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\"><span>tags.tag_id<\/span><\/div>\n<\/div>\n<\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/form\/smart_form_id\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"files\": [\r\n    {\r\n      \"smart_form_id\": 0,\r\n      \"friendly_form_name\": \"string\",\r\n      \"url\": \"string\",\r\n      \"create_date_utc\": \"2020-10-07T08:27:25Z\",\r\n      \"update_date_utc\": \"2020-10-07T08:27:25Z\",\r\n      \"tags\": [\r\n       {\r\n         \"name\": \"string\"\r\n       }\r\n    }\r\n  ]\r\n}\r\n<\/code><\/pre>\n<\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<div class=\"method\">\n<h4 id=\"getforms\">Get forms<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/forms<\/span><\/div>\n<p>Retrieve forms associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\"><span>smart_form_id<\/span><span>friendly_form_name<\/span><span>Url<\/span><span>create_date_utc<\/span><span>update_date_utc<\/span><span>tags.name<\/span><\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\"><span>tags.tag_id<\/span><\/div>\n<\/div>\n<\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 1000; maximum allowed value is 5000.<\/div>\n<\/div>\n<\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div>\n<\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is update_date_utc descending.<\/div>\n<\/div>\n<\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/forms\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"files\": [\r\n    {\r\n      \"smart_form_id\": 0,\r\n      \"friendly_form_name\": \"string\",\r\n      \"url\": \"string\",\r\n      \"create_date_utc\": \"2020-10-07T08:27:25Z\",\r\n      \"update_date_utc\": \"2020-10-07T08:27:25Z\",\r\n      \"tags\": [\r\n        {\r\n          \"name\": \"string\"\r\n        }\r\n      ],\r\n    }\r\n  ]\r\n}\r\n<\/code><\/pre>\n<\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<div class=\"method\">\n<h4 id=\"getformsubmissions\">Get form submissions<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/forms\/submissions\/{smart_form_id}<\/span><\/div>\n<p>Get information for a specific form submissions in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\"><span>submission_id<\/span><span>submitted_on_utc<\/span><span>contact.email<\/span><span>contact.title<\/span><span>contact.first_name<\/span><span>contact.last_name<\/span><span>contact.company<\/span><span>contact.create_date_utc<\/span><span>contact.contact_id<\/span><span>contact.last_active_utc<\/span><\/div>\n<\/div>\n<\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/forms\/submissions\/smart_form_id\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"form\": [\r\n        \"submission_id\": 0,\r\n        \"submitted_on_utc\": \"2020-10-07T08:27:25Z\",\r\n        \"contact\": {\r\n            \"contact_id\": 0,\r\n            \"email\": \"string\",\r\n            \"title\": \"string\",\r\n            \"first_name\": \"string\",\r\n            \"last_name\": \"string\",\r\n            \"company\": \"string\",\r\n            \"create_date_utc\": \"2020-10-07T08:27:25Z\",\r\n            \"last_active_utc\": \"2020-10-07T08:27:25Z\"\r\n        }\r\n    ]\r\n}\r\n<\/code><\/pre>\n<\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<div id=\"lists\" class=\"section\">\n<h3>Lists<\/h3>\n<p>Your StoneShot lists, both dynamic and static can be managed and queried.<\/p>\n<div class=\"method\">\n<h4 id=\"getlists\">Get lists<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/lists<\/span><\/div>\n<p>Retrieve lists associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>list_id<\/span><span>name<\/span><span>type<\/span><span>teams.name<\/span><span>tags.name<\/span><span>create_date_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>external_id<\/span><span>update_date_utc<\/span><span>teams.team_id<\/span><span>tags.tag_id<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is list_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the list name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">tag<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on lists with a given tag.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">team<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on lists with a given team.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">type<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results to &#8216;static&#8217; or &#8216;dynamic&#8217; lists only by including either keyword. Not including this parameter will return both static and dynamic lists.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/lists\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"lists\": [\r\n    {\r\n      \"name\": \"string\",\r\n      \"create_date_utc\": \"2020-10-07T08:27:25Z\",\r\n      \"tags\": [],\r\n      \"teams\": [],\r\n      \"type\": \"string\"\r\n    }\r\n  ]\r\n}\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"createlist\">Create list<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">POST<\/span><span class=\"request-code\">\/lists<\/span><\/div>\n<p>Create a new static list against your account.<\/p>\n<div class=\"method-detail\">\n<h5>Body parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">name<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of your list.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">tags<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The tags to be assigned to your list.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">teams<\/span><span class=\"parameter-type\">object<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The teams to be assigned to your list.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X POST \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/lists\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\" \\\r\n\t-H \"Content-Type: application\/JSON\" \\\r\n  -d '{\"name\": \"string\"}'\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"list\": {\r\n    \"name\": \"string\",\r\n    \"create_date_utc\": \"2020-10-16T12:06:34Z\",\r\n    \"tags\": [],\r\n    \"teams\": [],\r\n    \"type\": \"string\"\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"118\",\r\n  \"message\": \"Required parameter\/s not supplied\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getlist\">Get list<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/lists\/{list_id}<\/span><\/div>\n<p>Get information for a specific list in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">list_id<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The unique StoneShot list id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>list_id<\/span><span>name<\/span><span>type<\/span><span>teams.name<\/span><span>tags.name<\/span><span>create_date_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>external_id<\/span><span>update_date_utc<\/span><span>teams.team_id<\/span><span>tags.tag_id<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/lists\/[list_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"list\": {\r\n    \"name\": \"string\",\r\n    \"create_date_utc\": \"2020-06-23T16:12:18Z\",\r\n    \"tags\": [],\r\n    \"teams\": [],\r\n    \"type\": \"string\"\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getlistcontacts\">Get list contacts<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/lists\/{list_id}\/contacts<\/span><\/div>\n<p>Get contact information for all contacts that form part of a specific list.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">list_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot list id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>email<\/span><span>title<\/span><span>first_name<\/span><span>last_name<\/span><span>company<\/span><span>create_date_utc<\/span><span>contact_id<\/span><span>last_active_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>middle_name<\/span><span>website<\/span><span>job_title<\/span><span>telephone<\/span><span>telephone_ext<\/span><span>fax<\/span><span>mobile_number<\/span><span>home_number<\/span><span>address_1<\/span><span>address_2<\/span><span>address_3<\/span><span>address_4<\/span><span>city<\/span><span>county<\/span><span>postcode<\/span><span>country<\/span><span>opt_in<\/span><span>custom_1<\/span><span>custom_2<\/span><span>custom_3<\/span><span>custom_4<\/span><span>custom_5<\/span><span>custom_6<\/span><span>custom_7<\/span><span>custom_8<\/span><span>custom_9<\/span><span>custom_10<\/span><span>custom_11<\/span><span>custom_12<\/span><span>prefer_html<\/span><span>create_date_utc<\/span><span>is_bounce<\/span><span>salesforce_account_id<\/span><span>salesforce_owner_id<\/span><span>double_opt_in_status<\/span><span>unique_user_id<\/span><span>salesforce_id<\/span><span>siebel_id<\/span><span>dynamics_id<\/span><span>segments.segment_id<\/span><span>segments.name<\/span><span>segments.segmentation.name<\/span><span>segments.segmentation.segmentation_id<\/span><span>email_preferences.segment_id<\/span><span>email_preferences.name<\/span><span>email_preferences.segmentation.name<\/span><span>email_preferences.segmentation.segmentation_id<\/span><span>content_preferences.content_tag_id<\/span><span>content_preferences.tag.tag_id<\/span><span>content_preferences.tag.name<\/span><span>events.segment_id<\/span><span>events.name<\/span><span>events.segmentation.name<\/span><span>events.segmentation.segmentation_id<\/span><span>events.session.session_id<\/span><span>events.session.location<\/span><span>events.session.event.event_id<\/span><span>events.session.event.name<\/span><span>document_preferences.segment_id<\/span><span>document_preferences.name<\/span><span>document_preferences.segmentation.name<\/span><span>document_preferences.segmentation.segmentation_id<\/span><br \/>\n\t\t\t\t\t\t\t\t\t<span>custom_fields.value<\/span><span>custom_fields.custom_field.custom_field_id<\/span><span>custom_fields.custom_field.name<\/span><span>custom_fields.custom_field.display_name<\/span><span>contact_guid<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 1000; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is contact_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">contact_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on a unique StoneShot contact id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact email address.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">first_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact first name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">last_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact last name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">company<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact company.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">job_title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact job title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">city<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact city.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">county<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact county.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">country<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact country.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact salesforce id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact siebel id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">dynamics_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact microsoft dynamics id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact unique external user id.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/lists\/[list_id]\/contacts\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contacts\": [\r\n    {\r\n      \"contact_id\": 0,\r\n      \"email\": \"string\",\r\n      \"title\": \"string\",\r\n      \"first_name\": \"string\",\r\n      \"last_name\": \"string\",\r\n      \"company\": \"string\",\r\n      \"create_date_utc\": \"2020-07-14T13:16:00Z\"\r\n    },\t\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"addcontacttolist\">Add contact to list<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">PATCH<\/span><span class=\"request-code\">\/lists\/{list_id}\/contacts\/add<\/span><\/div>\n<p>Add an existing contact to a specific static list.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">list_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot list id.<\/div>\n<\/div><\/div>\n<h5>Body parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">member_url_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact member url (optional)<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact salesforce id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">dynamics_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact microsoft dynamics id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact siebel id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact unique external user id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">contact_id<\/span><span class=\"parameter-type\">integer<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot contact id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact email address (optional).<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X PATCH \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/lists\/[list_id]\/contacts\/add\"\r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\" \\\r\n\t-H \"Content-Type: application\/JSON\" \\\r\n  -d '{\"email\": \"string\"}'\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contacts\": [\r\n    {\r\n      \"contact_id\": 0,\r\n      \"email\": \"string\",\r\n      \"title\": \"string\",\r\n      \"first_name\": \"string\",\r\n      \"last_name\": \"string\",\r\n      \"company\": \"string\",\r\n      \"create_date_utc\": \"2017-07-27T17:34:51Z\"\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"removecontactfromlist\">Remove contact from list<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">PATCH<\/span><span class=\"request-code\">\/lists\/{list_id}\/contacts\/remove<\/span><\/div>\n<p>Remove a contact from a specific static list.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">list_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot list id.<\/div>\n<\/div><\/div>\n<h5>Body parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">member_url_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact member url (optional)<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact salesforce id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">dynamics_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact microsoft dynamics id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact siebel id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact unique external user id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">contact_id<\/span><span class=\"parameter-type\">integer<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot contact id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact email address (optional).<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X PATCH \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/lists\/[list_id]\/contacts\/remove\"\r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\" \\\r\n\t-H \"Content-Type: application\/JSON\" \\\r\n  -d '{\"email\": \"string\"}'\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contacts\": [\r\n    {\r\n      \"contact_id\": 0,\r\n      \"email\": \"string\",\r\n      \"title\": \"string\",\r\n      \"first_name\": \"string\",\r\n      \"last_name\": \"string\",\r\n      \"company\": \"string\",\r\n      \"create_date_utc\": \"2017-07-27T17:34:51Z\"\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"ping\" class=\"section\">\n<h3>Ping<\/h3>\n<p>Check the StoneShot API status.<\/p>\n<div class=\"method\">\n<h4 id=\"pingrequest\">Ping request<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/ping<\/span><\/div>\n<p>Ping the StoneShot API to return the current status.<\/p>\n<div class=\"method-detail\">\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/ping\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"code\": \"100\",\r\n  \"message\": \"Success\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"segmentation\" class=\"section\">\n<h3>Segmentation<\/h3>\n<p>Your StoneShot segmentation, a powerful feature for segmenting contacts.<\/p>\n<div class=\"method\">\n<h4 id=\"getsegmentations\">Get segmentations<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/segmentations<\/span><\/div>\n<p>Retrieve all segmentations against your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>segmentation_id<\/span><span>name<\/span><span>display_order<\/span><span>segments.segment_id<\/span><span>segments.name<\/span><span>segments.display_order<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>dynamic_system_name<\/span><span>segments.details<\/span><span>segments.dynamic_from_email<\/span><span>segments.dynamic_from_name<\/span><span>segments.dynamic_fields.dynamic_field_id<\/span><span>segments.dynamic_fields.name<\/span><span>segments.dynamic_fields.display_order<\/span><span>segments.dynamic_fields.html_content<\/span><span>segments.dynamic_fields.text_content<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is segmentation_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the segmentation name.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/segmentations\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"segmentations\": [\r\n    {\r\n      \"segmentation_id\": 0,\r\n      \"name\": \"string\",      \r\n      \"display_order\": 0,\r\n      \"segments\": [\r\n        {\r\n          \"segment_id\": 0,          \r\n          \"name\": \"string\",\r\n          \"display_order\": 0\r\n        },\r\n        {\r\n          \"segment_id\": 0,          \r\n          \"name\": \"string\",\r\n          \"display_order\": 0\r\n        }\r\n      ]\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getsegmentation\">Get segmentation<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/segmentations\/{segmentation_id}<\/span><\/div>\n<p>Retrieve segmentation against your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">segmentation_id<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">The unique StoneShot segmentation id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>segmentation_id<\/span><span>name<\/span><span>display_order<\/span><span>segments.segment_id<\/span><span>segments.name<\/span><span>segments.display_order<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>dynamic_system_name<\/span><span>segments.details<\/span><span>segments.dynamic_from_email<\/span><span>segments.dynamic_from_name<\/span><span>segments.dynamic_fields.dynamic_field_id<\/span><span>segments.dynamic_fields.name<\/span><span>segments.dynamic_fields.display_order<\/span><span>segments.dynamic_fields.html_content<\/span><span>segments.dynamic_fields.text_content<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/segmentations\/[segmentation_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"segmentation\": [\r\n    {\r\n      \"segmentation_id\": 0,\r\n      \"name\": \"string\",      \r\n      \"display_order\": 0,\r\n      \"segments\": [\r\n        {\r\n          \"segment_id\": 0,          \r\n          \"name\": \"string\",\r\n          \"display_order\": 0\r\n        },\r\n        {\r\n          \"segment_id\": 0,          \r\n          \"name\": \"string\",\r\n          \"display_order\": 0\r\n        }\r\n      ]\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"tags\" class=\"section\">\n<h3>Tags<\/h3>\n<p>Retrieve, create or update tags your tags and more.<\/p>\n<div class=\"method\">\n<h4 id=\"gettags\">Get tags<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/tags<\/span><\/div>\n<p>Retrieve tags associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Request parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>tag_id<\/span><span>name<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is tag_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on the name of the tag.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/tags\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"  \r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"tags\": [\r\n    {\r\n      \"tag_id\": 0,\r\n      \"name\": \"string\"\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"createtag\">Create tag<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">POST<\/span><span class=\"request-code\">\/tags<\/span><\/div>\n<p>Create a new tag against your account.<\/p>\n<div class=\"method-detail\">\n<h5>Body parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">name<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the tag.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X POST \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/tags\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\" \\\r\n\t-H \"Content-Type: application\/JSON\" \\\r\n  -d '{\"name\": \"string\"}'\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"tag\": {\r\n    \"tag_id\": 0,\r\n    \"name\": \"string\"\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"118\",\r\n  \"message\": \"Required parameter\/s not supplied\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"gettag\">Get tag<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/tags\/{tag_id}<\/span><\/div>\n<p>Get information for a specific tag in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">tag_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot tag id.<\/div>\n<\/div><\/div>\n<h5>Request parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>tag_id<\/span><span>name<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/tags\/[tag_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"  \r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"tag\": {\r\n    \"tag_id\": 0,\r\n    \"name\": \"string\"\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"updatetag\">Update tag<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">PATCH<\/span><span class=\"request-code\">\/tags\/{tag_id}<\/span><\/div>\n<p>Update a tag record in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">tag_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot tag id.<\/div>\n<\/div><\/div>\n<h5>Body parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">name<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the tag.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X PATCH \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/tags\/[tag_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\" \\\r\n\t-H \"Content-Type: application\/JSON\" \\\r\n  -d '{\"name\": \"string\"}'\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"tag\": {\r\n    \"tag_id\": 0,\r\n    \"name\": \"string\"\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"122\",\r\n  \"message\": \"That record already exists\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"templates\" class=\"section\">\n<h3>Templates<\/h3>\n<p>Your StoneShot templates can be managed and queried.<\/p>\n<div class=\"method\">\n<h4 id=\"gettemplates\">Get templates<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/templates<\/span><\/div>\n<p>Retrieve templates associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>template_id<\/span><span>name<\/span><span>subject<\/span><span>from_name<\/span><span>from_email<\/span><span>teams.name<\/span><span>tags.name<\/span><span>create_date_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>update_date_utc<\/span><span>b_subject<\/span><span>reply_to_address<\/span><span>encoding<\/span><span>teams.team_id<\/span><span>tags.tag_id<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is template_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the template name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">tag<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on templates with a given tag.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">team<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on templates with a given team.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/templates\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"templates\": [\r\n    {\r\n      \"name\": \"string\",\r\n      \"create_date_utc\": \"2020-10-07T08:27:25Z\",\r\n      \"tags\": [],\r\n      \"teams\": [],\r\n      \"subject\": \"string\",\r\n      \"from_name\": \"string\",\r\n      \"from_email\": \"string\"\r\n    }\r\n  ]\r\n}\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"gettemplate\">Get template<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/templates\/{template_id}<\/span><\/div>\n<p>Get information for a specific template in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">template_id<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The unique StoneShot template id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>template_id<\/span><span>name<\/span><span>subject<\/span><span>from_name<\/span><span>from_email<\/span><span>html_share_link<\/span><span>text_share_link<\/span><span>teams.name<\/span><span>tags.name<\/span><span>create_date_utc<\/span><span>list.list_id<\/span><span>list.name<\/span><span>list.type<\/span><span>list.create_date_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>update_date_utc<\/span><span>b_subject<\/span><span>reply_to_address<\/span><span>encoding<\/span><span>teams.team_id<\/span><span>tags.tag_id<\/span><span>list.external_id<\/span><span>list.update_date_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/templates\/[template_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"template\": {\r\n    \"name\": \"string\",\r\n    \"html_share_link\": \"string\",\r\n    \"text_share_link\": \"string\",\r\n    \"create_date_utc\": \"2020-06-23T16:12:18Z\",\r\n    \"tags\": [],\r\n    \"teams\": [],\r\n    \"subject\": \"string\",\r\n    \"from_name\": \"string\",\r\n    \"from_email\": \"string\",\r\n    \"list\": {\r\n        \"list_id\": 0,\r\n        \"name\": \"string\",\r\n        \"create_date_utc\": \"2020-06-23T16:12:18Z\",\r\n        \"type\": \"string\"\r\n    }\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"users\" class=\"section\">\n<h3>Users<\/h3>\n<p>Your StoneShot users can be managed and queried.<\/p>\n<div class=\"method\">\n<h4 id=\"getusers\">Get users<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/users<\/span><\/div>\n<p>Retrieve users associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>user_id<\/span><span>login_name<\/span><span>first_name<\/span><span>last_name<\/span><span>email<\/span><span>last_login_date_utc<\/span><span>enabled<\/span><span>login_type<\/span><span>access_level<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>external_id<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is user_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">email<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the user&#8217;s email.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/users\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"users\": [\r\n    {\r\n      \"user_id\": 0,\r\n      \"login_name\": \"string\",\r\n      \"email\": \"string\",\r\n      \"enabled\": boolean,\r\n      \"last_login_date_utc\": \"2020-06-23T16:12:18Z\",\r\n      \"first_name\": \"string\",\r\n      \"last_name\": \"string\"\r\n    }\r\n  ]\r\n}\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getuser\">Get user<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/users\/{user_id}<\/span><\/div>\n<p>Get information for a specific user in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">user_id<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The unique StoneShot user id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>user_id<\/span><span>login_name<\/span><span>first_name<\/span><span>last_name<\/span><span>email<\/span><span>last_login_date_utc<\/span><span>enabled<\/span><span>login_type<\/span><span>access_level<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>external_id<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/users\/[user_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"user\": {\r\n        \"user_id\": 0,\r\n        \"login_name\": \"string\",\r\n        \"email\": \"string\",\r\n        \"enabled\": boolean,\r\n        \"last_login_date_utc\": \"2020-06-23T16:12:18Z\",\r\n        \"first_name\": \"string\",\r\n        \"last_name\": \"string\"\r\n    }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"updateuser\">Update user<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">PATCH<\/span><span class=\"request-code\">\/users\/{user_id}<\/span><\/div>\n<p>Update the details for a user in your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">user_id<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">The unique StoneShot user id.<\/div>\n<\/div><\/div>\n<h5>Body parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">email<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">The email address of the user.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">last_name<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">The last name of the user.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-3\"><span class=\"parameter\">enabled<\/span><span class=\"parameter-type\">boolean<\/span><\/div>\n<div class=\"col-md-9\">\n<div class=\"request-item-desc\">Whether or not the user should have access to StoneShot.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X PATCH \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/users\/[user_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\" \\\r\n\t-H \"Content-Type: application\/JSON\" \\\r\n  -d '{\"email\": \"string\", \"last_name\": \"string\", \"enabled\": boolean}'\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"user\": {\r\n        \"user_id\": 0,\r\n        \"login_name\": \"string\",\r\n        \"email\": \"string\",\r\n        \"enabled\": boolean,\r\n        \"last_login_date_utc\": \"2020-06-23T16:12:18Z\",\r\n        \"first_name\": \"string\",\r\n        \"last_name\": \"string\"\r\n    }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"130\",\r\n  \"message\": \"Admin\/API-only users cannot be updated\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"visittracking\" class=\"section\">\n<h3>Visit Tracking<\/h3>\n<p>Your StoneShot tracked sites can be managed and queried.<\/p>\n<div class=\"method\">\n<h4 id=\"getsites\">Get sites<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/sites<\/span><\/div>\n<p>Retrieve tracked sites associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>site_id<\/span><span>name<\/span><span>created_date_utc<\/span><span>main_url<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is site_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the site name.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/sites\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"sites\": [\r\n    {\r\n      \"site_id\": 0,\r\n      \"name\": \"string\",\r\n      \"main_url\": \"string\",\r\n      \"created_date_utc\": \"2020-09-15T15:19:45Z\"\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getsitevisitors\">Get site visitors<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/sites\/{site_id}\/visitors<\/span><\/div>\n<p>Retrieve details of visits to your tracked site. Visits from unknown contacts are grouped together into one child.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">site_id<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The unique StoneShot site id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>visits<\/span><span>page_views<\/span><span>total_bounces<\/span><span>site.site_id<\/span><span>site.name<\/span><span>site.created_date_utc<\/span><span>site.main_url<\/span><span>contact.email<\/span><span>contact.title<\/span><span>contact.first_name<\/span><span>contact.last_name<\/span><span>contact.company<\/span><span>contact.create_date_utc<\/span><span>contact.contact_id<\/span><span>contact.last_active_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>contact.middle_name<\/span><span>contact.website<\/span><span>contact.job_title<\/span><span>contact.telephone<\/span><span>contact.telephone_ext<\/span><span>contact.fax<\/span><span>contact.mobile_number<\/span><span>contact.home_number<\/span><span>contact.address_1<\/span><span>contact.address_2<\/span><span>contact.address_3<\/span><span>contact.address_4<\/span><span>contact.city<\/span><span>contact.county<\/span><span>contact.postcode<\/span><span>contact.country<\/span><span>contact.opt_in<\/span><span>contact.custom_1<\/span><span>contact.custom_2<\/span><span>contact.custom_3<\/span><span>contact.custom_4<\/span><span>contact.custom_5<\/span><span>contact.custom_6<\/span><span>contact.custom_7<\/span><span>contact.custom_8<\/span><span>contact.custom_9<\/span><span>contact.custom_10<\/span><span>contact.custom_11<\/span><span>contact.custom_12<\/span><span>contact.prefer_html<\/span><span>contact.is_bounce<\/span><span>contact.salesforce_account_id<\/span><span>contact.salesforce_owner_id<\/span><span>contact.unique_user_id<\/span><span>contact.salesforce_id<\/span><span>contact.siebel_id<\/span><span>contact.dynamics_id<\/span><span>contact_guid<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 1000; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is visits descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">from_date_utc<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Only retrieve visits that occurred on or after this date. Provide in the following format: &#8220;yyyy-MM-ddTHH:mm:ss.fffZ&#8221;.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">to_date_utc<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Only retrieve visits that occurred on or before this date. Provide in the following format: &#8220;yyyy-MM-ddTHH:mm:ss.fffZ&#8221;.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">contact_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on a unique StoneShot contact id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact email address.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">first_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact first name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">last_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact last name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">company<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact company.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">job_title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact job title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">city<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact city.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">county<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact county.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">country<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact country.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact salesforce id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact siebel id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">dynamics_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact microsoft dynamics id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact unique external user id.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/sites\/[site_id]\/visitors\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"visitors\": {\r\n    \"visits\": 0,\r\n    \"page_views\": 0,\r\n    \"total_bounces\": 0,\r\n    \"site\": {\r\n      \"site_id\": 0,\r\n      \"name\": \"string\",\r\n      \"main_url\": \"string\",\r\n      \"created_date_utc\": \"2018-12-14T22:38:26Z\"\r\n    },\r\n    \"contact\": {\r\n      \"contact_id\": 0,\r\n      \"email\": \"string\",\r\n      \"title\": \"string\",\r\n      \"first_name\": \"string\",\r\n      \"last_name\": \"string\",\r\n      \"company\": \"string\",\r\n      \"create_date_utc\": \"2018-05-16T08:47:33Z\",\r\n      \"last_active_utc\": \"2021-01-27T16:22:08Z\"\r\n    }\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getsitevisitor\">Get site visitor<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/sites\/{site_id}\/visitors\/{identifier}<\/span><\/div>\n<p>Retrieve details of visits to your tracked site from a specific contact.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">site_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot site id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">identifier<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">A unique identifier for the contact. See <a class=\"matching-anchor\" href=\"#contactmatching\">contact matching<\/a> for a list of the supported identifiers.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>visits<\/span><span>page_views<\/span><span>total_bounces<\/span><span>site.site_id<\/span><span>site.name<\/span><span>site.created_date_utc<\/span><span>site.main_url<\/span><span>contact.email<\/span><span>contact.title<\/span><span>contact.first_name<\/span><span>contact.last_name<\/span><span>contact.company<\/span><span>contact.create_date_utc<\/span><span>contact.contact_id<\/span><span>contact.last_active_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>contact.middle_name<\/span><span>contact.website<\/span><span>contact.job_title<\/span><span>contact.telephone<\/span><span>contact.telephone_ext<\/span><span>contact.fax<\/span><span>contact.mobile_number<\/span><span>contact.home_number<\/span><span>contact.address_1<\/span><span>contact.address_2<\/span><span>contact.address_3<\/span><span>contact.address_4<\/span><span>contact.city<\/span><span>contact.county<\/span><span>contact.postcode<\/span><span>contact.country<\/span><span>contact.opt_in<\/span><span>contact.custom_1<\/span><span>contact.custom_2<\/span><span>contact.custom_3<\/span><span>contact.custom_4<\/span><span>contact.custom_5<\/span><span>contact.custom_6<\/span><span>contact.custom_7<\/span><span>contact.custom_8<\/span><span>contact.custom_9<\/span><span>contact.custom_10<\/span><span>contact.custom_11<\/span><span>contact.custom_12<\/span><span>contact.prefer_html<\/span><span>contact.is_bounce<\/span><span>contact.salesforce_account_id<\/span><span>contact.salesforce_owner_id<\/span><span>contact.unique_user_id<\/span><span>contact.salesforce_id<\/span><span>contact.siebel_id<\/span><span>contact.dynamics_id<\/span><span>contact_guid<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">from_date_utc<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Only retrieve visits that occurred on or after this date. Provide in the following format: &#8220;yyyy-MM-ddTHH:mm:ss.fffZ&#8221;.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">to_date_utc<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Only retrieve visits that occurred on or before this date. Provide in the following format: &#8220;yyyy-MM-ddTHH:mm:ss.fffZ&#8221;.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/sites\/[site_id]\/visitors\/[identifier]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"visitor\": {\r\n    \"visits\": 0,\r\n    \"page_views\": 0,\r\n    \"total_bounces\": 0,\r\n    \"site\": {\r\n      \"site_id\": 0,\r\n      \"name\": \"string\",\r\n      \"main_url\": \"string\",\r\n      \"created_date_utc\": \"2018-12-14T22:38:26Z\"\r\n    },\r\n    \"contact\": {\r\n      \"contact_id\": 0,\r\n      \"email\": \"string\",\r\n      \"title\": \"string\",\r\n      \"first_name\": \"string\",\r\n      \"last_name\": \"string\",\r\n      \"company\": \"string\",\r\n      \"create_date_utc\": \"2018-05-16T08:47:33Z\",\r\n      \"last_active_utc\": \"2021-01-27T16:22:08Z\"\r\n    }\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"132\",\r\n  \"message\": \"Invalid date format. Please provide dates in the following format: {yyyy-MM-ddTHH:mm:ss.fffZ}\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getvisitactivites\">Get site visit activities<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/sites\/{site_id}\/visits\/activities<\/span><\/div>\n<p>Retrieve visit activity details for your tracked site.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">site_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot site id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>activity_date_utc<\/span><span>page_visited<\/span><span>location_ip<\/span><span>friendly_page_name<\/span><span>new_or_returning<\/span><span>site.site_id<\/span><span>site.name<\/span><span>site.created_date_utc<\/span><span>site.main_url<\/span><span>contact.email<\/span><span>contact.title<\/span><span>contact.first_name<\/span><span>contact.last_name<\/span><span>contact.company<\/span><span>contact.create_date_utc<\/span><span>contact.contact_id<\/span><span>contact.last_active_utc<\/span><span>campaign.campaign_id<\/span><span>campaign_name<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>browser<\/span><span>referrer<\/span><span>screen_resolution<\/span><span>duration<\/span><span>contact.middle_name<\/span><span>contact.website<\/span><span>contact.job_title<\/span><span>contact.telephone<\/span><span>contact.telephone_ext<\/span><span>contact.fax<\/span><span>contact.mobile_number<\/span><span>contact.home_number<\/span><span>contact.address_1<\/span><span>contact.address_2<\/span><span>contact.address_3<\/span><span>contact.address_4<\/span><span>contact.city<\/span><span>contact.county<\/span><span>contact.postcode<\/span><span>contact.country<\/span><span>contact.opt_in<\/span><span>contact.custom_1<\/span><span>contact.custom_2<\/span><span>contact.custom_3<\/span><span>contact.custom_4<\/span><span>contact.custom_5<\/span><span>contact.custom_6<\/span><span>contact.custom_7<\/span><span>contact.custom_8<\/span><span>contact.custom_9<\/span><span>contact.custom_10<\/span><span>contact.custom_11<\/span><span>contact.custom_12<\/span><span>contact.prefer_html<\/span><span>contact.is_bounce<\/span><span>contact.salesforce_account_id<\/span><span>contact.salesforce_owner_id<\/span><span>contact.unique_user_id<\/span><span>contact.salesforce_id<\/span><span>contact.siebel_id<\/span><span>contact.dynamics_id<\/span><span>contact_guid<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 1000; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is activity_date_utc descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unknown<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Boolean field (true\/false) to specify whether unknown visits should be included. Default is to include known and unknown.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">from_date_utc<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Only retrieve visits that occurred on or after this date. Provide in the following format: &#8220;yyyy-MM-ddTHH:mm:ss.fffZ&#8221;.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">to_date_utc<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Only retrieve visits that occurred on or before this date. Provide in the following format: &#8220;yyyy-MM-ddTHH:mm:ss.fffZ&#8221;.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">contact_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on a unique StoneShot contact id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact email address.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">first_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact first name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">last_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact last name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">company<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact company.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">job_title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact job title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">city<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact city.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">county<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact county.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">country<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact country.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact salesforce id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact siebel id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">dynamics_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact microsoft dynamics id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact unique external user id.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/sites\/[site_id]\/visits\/activities\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"activities\": {\r\n    \"activity_date_utc\": \"2020-01-20T11:12:31Z\",\r\n    \"page_visited\": \"string\",\r\n    \"location_ip\": \"string\",\r\n    \"friendly_page_name\": \"string\",\r\n    \"site\": {\r\n      \"site_id\": 0,\r\n      \"name\": \"string\",\r\n      \"main_url\": \"string\",\r\n      \"created_date_utc\": \"2018-12-14T22:38:26Z\"\r\n    },\r\n    \"contact\": {\r\n      \"contact_id\": 0,\r\n      \"email\": \"string\",\r\n      \"title\": \"string\",\r\n      \"first_name\": \"string\",\r\n      \"last_name\": \"string\",\r\n      \"company\": \"string\",\r\n      \"create_date_utc\": \"2018-05-16T08:47:33Z\",\r\n      \"last_active_utc\": \"2021-01-27T16:22:08Z\"\r\n    },\r\n    \"campaign\": {\r\n      \"campaign_id\": 0,\r\n      \"name\": \"string\"\r\n    },\r\n    \"new_or_returning\": \"string\"\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"132\",\r\n  \"message\": \"Invalid date format. Please provide dates in the following format: {yyyy-MM-ddTHH:mm:ss.fffZ}\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getvisitactivitesforcontact\">Get site visitor activities<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/sites\/{site_id}\/visits\/activities\/contacts\/{identifier}<\/span><\/div>\n<p>Retrieve details of visit activity on your tracked site by a specific contact.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">site_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot site id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">identifier<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">A unique identifier for the contact. See <a class=\"matching-anchor\" href=\"#contactmatching\">contact matching<\/a> for a list of the supported identifiers.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>email<\/span><span>title<\/span><span>first_name<\/span><span>last_name<\/span><span>company<\/span><span>create_date_utc<\/span><span>contact_id<\/span><span>last_active_utc<\/span><span>visit_activities.activity_date_utc<\/span><span>visit_activities.page_visited<\/span><span>visit_activities.location_ip<\/span><span>visit_activities.friendly_page_name<\/span><span>visit_activities.new_or_returning<\/span><span>visit_activities.site.site_id<\/span><span>visit_activities.site.name<\/span><span>visit_activities.site.created_date_utc<\/span><span>visit_activities.site.main_url<\/span><span>visit_activities.campaign.campaign_id<\/span><span>visit_activities.campaign_name<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>middle_name<\/span><span>website<\/span><span>job_title<\/span><span>telephone<\/span><span>telephone_ext<\/span><span>fax<\/span><span>mobile_number<\/span><span>home_number<\/span><span>address_1<\/span><span>address_2<\/span><span>address_3<\/span><span>address_4<\/span><span>city<\/span><span>county<\/span><span>postcode<\/span><span>country<\/span><span>opt_in<\/span><span>custom_1<\/span><span>custom_2<\/span><span>custom_3<\/span><span>custom_4<\/span><span>custom_5<\/span><span>custom_6<\/span><span>custom_7<\/span><span>custom_8<\/span><span>custom_9<\/span><span>custom_10<\/span><span>custom_11<\/span><span>custom_12<\/span><span>prefer_html<\/span><span>is_bounce<\/span><span>salesforce_account_id<\/span><span>salesforce_owner_id<\/span><span>unique_user_id<\/span><span>salesforce_id<\/span><span>siebel_id<\/span><span>dynamics_id<\/span><span>visit_activities.browser<\/span><span>visit_activities.referrer<\/span><span>visit_activities.screen_resolution<\/span><span>visit_activities.duration<\/span><span>contact_guid<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">from_date_utc<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Only retrieve visits that occurred on or after this date. Provide in the following format: &#8220;yyyy-MM-ddTHH:mm:ss.fffZ&#8221;.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">to_date_utc<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Only retrieve visits that occurred on or before this date. Provide in the following format: &#8220;yyyy-MM-ddTHH:mm:ss.fffZ&#8221;.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/sites\/[site_id]\/visits\/activities\/contacts\/[identifier]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contact\": {\r\n    \"contact_id\": 0,\r\n    \"email\": \"string\",\r\n    \"title\": \"string\",\r\n    \"first_name\": \"string\",\r\n    \"last_name\": \"string\",\r\n    \"company\": \"string\",\r\n    \"create_date_utc\": \"2018-10-29T18:03:09Z\",\r\n    \"last_active_utc\": \"2021-01-07T14:37:37Z\",\r\n    \"visit_activities\": [\r\n      {\r\n        \"activity_date_utc\": \"2021-01-19T17:40:59Z\",\r\n        \"page_visited\": \"string\",\r\n        \"location_ip\": \"string\",\r\n        \"friendly_page_name\": \"string\",\r\n        \"site\": {\r\n          \"site_id\": 0,\r\n          \"name\": \"string\",\r\n          \"main_url\": \"string\",\r\n          \"created_date_utc\": \"2018-12-14T22:38:26Z\"\r\n        },\r\n        \"campaign\": {\r\n          \"campaign_id\": 0,\r\n          \"name\": \"string\"\r\n        },\r\n        \"new_or_returning\": \"string\"\r\n      }\r\n    ]\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"132\",\r\n  \"message\": \"Invalid date format. Please provide dates in the following format: {yyyy-MM-ddTHH:mm:ss.fffZ}\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getgoalsforsite\">Get goals for site<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/sites\/{site_id}\/goals<\/span><\/div>\n<p>\t\t\t\t\tRetrieve details of goals assigned to your tracked site.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">site_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot site id.<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\"><span>goal_id<\/span><span>site_id<\/span><span>name<\/span><span>match_attribute<\/span><span>pattern<\/span><span>pattern_type<\/span><span>is_case_sensitive<\/span><span>allow_multiple<\/span><span>archived<\/span><span>weighting_id<\/span><\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\"><span>site.site_id<\/span><span>site.name<\/span><span>site.main_url<\/span><span>site.created_date_utc<\/span><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 1000; maximum allowed value is 1000.<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is activity_date_utc descending.<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the site name.<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/sites\/{site_id}\/goals\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>\r\n    {\r\n    \"goals\": [\r\n    {\r\n    \"goal_id\": 0,\r\n    \"site_id\": 0,\r\n    \"name\": \"string\",\r\n    \"match_attribute\": 0,\r\n    \"pattern\": \"string\",\r\n    \"pattern_type\": 0,\r\n    \"is_case_sensitive\": false,\r\n    \"allow_multiple\": false,\r\n    \"archived\": false,\r\n    \"weighting_id\": 0\r\n    },\r\n    {\r\n    \"goal_id\": 0,\r\n    \"site_id\": 0,\r\n    \"name\": \"string\",\r\n    \"match_attribute\": 0,\r\n    \"pattern\": \"string\",\r\n    \"pattern_type\": 0,\r\n    \"is_case_sensitive\": false,\r\n    \"allow_multiple\": false,\r\n    \"archived\": false,\r\n    \"weighting_id\": 0\r\n    }\r\n    ]\r\n    }\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>\r\n    {\r\n    \"code\": \"117\",\r\n    \"message\": \"No data found\"\r\n    }\r\n<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getgoalforsite\">Get goal for site<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/goals\/{goal_id}<\/span><\/div>\n<p>\t\t\t\t\tRetrieve details of a goal assigned to your tracked site.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">goal_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot goal id.<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\"><span>goal_id<\/span><span>site_id<\/span><span>name<\/span><span>match_attribute<\/span><span>pattern<\/span><span>pattern_type<\/span><span>is_case_sensitive<\/span><span>allow_multiple<\/span><span>archived<\/span><span>weighting_id<\/span><\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\"><span>site.site_id<\/span><span>site.name<\/span><span>site.main_url<\/span><span>site.created_date_utc<\/span><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/goals\/{goal_id}\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>\r\n    {\r\n    \"goal\": {\r\n    \"goal_id\": 0,\r\n    \"site_id\": 0,\r\n    \"name\": \"string\",\r\n    \"match_attribute\": 0,\r\n    \"pattern\": \"string\",\r\n    \"pattern_type\": 0,\r\n    \"is_case_sensitive\": false,\r\n    \"allow_multiple\": false,\r\n    \"archived\": false,\r\n    \"weighting_id\": 0\r\n    }\r\n    }\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>\r\n    {\r\n    \"code\": \"117\",\r\n    \"message\": \"No data found\"\r\n    }\r\n<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getconversionsforsite\">Get conversions for site<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/sites\/{site_id}\/conversions<\/span><\/div>\n<p>\t\t\t\t\tRetrieve details of conversions assigned to your tracked site.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">site_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot site id.<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\"><span>conversion_id<\/span><span>site_id<\/span><span>visit_id<\/span><span>visitor_id<\/span><span>goal_id<\/span><span>visit_action_id<\/span><span>when_converted_utc<\/span><span>url_action_lookup_id<\/span><span>url<\/span><span>visitor_days_since_first<\/span><span>visitor_returning<\/span><span>visitor_count_visits<\/span><span>referer_keyword<\/span><span>referer_name<\/span><span>referer_type<\/span><span>custom_var_k1<\/span><span>custom_var_v1<\/span><span>custom_var_k2<\/span><span>custom_var_v2<\/span><span>custom_var_k3<\/span><span>custom_var_v3<\/span><span>custom_var_k4<\/span><span>custom_var_v4<\/span><span>custom_var_k5<\/span><span>custom_var_v5<\/span><span>contact_id<\/span><span>activity_detail_id<\/span><\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\"><span>site.site_id<\/span><span>site.name<\/span><span>site.main_url<\/span><span>site.created_date_utc<\/span><span>goal.goal_id<\/span><span>goal.site_id<\/span><span>goal.name<\/span><span>goal.match_attribute<\/span><span>goal.pattern<\/span><span>goal.pattern_type<\/span><span>goal.is_case_sensitive<\/span><span>goal.allow_multiple<\/span><span>goal.archived<\/span><span>goal.weighting_id<\/span><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 1000; maximum allowed value is 1000.<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is activity_date_utc descending.<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the site name.<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/sites\/{site_id}\/conversions\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>\r\n    {\r\n    \"trackerConversions\": [\r\n    {\r\n    \"conversion_id\": 0,\r\n    \"site_id\": 0,\r\n    \"visit_id\": 0,\r\n    \"visitor_id\": \"string\",\r\n    \"goal_id\": 0,\r\n    \"visit_action_id\": 0,\r\n    \"when_converted_utc\": \"2021-09-17T20:58:23Z\",\r\n    \"url_action_lookup_id\": 0,\r\n    \"url\": \"string\",\r\n    \"visitor_days_since_first\": 0,\r\n    \"visitor_returning\": false,\r\n    \"visitor_count_visits\": 0,\r\n    \"referer_keyword\": null,\r\n    \"referer_name\": null,\r\n    \"referer_type\": false,\r\n    \"custom_var_k1\": null,\r\n    \"custom_var_v1\": null,\r\n    \"custom_var_k2\": null,\r\n    \"custom_var_v2\": null,\r\n    \"custom_var_k3\": null,\r\n    \"custom_var_v3\": null,\r\n    \"custom_var_k4\": null,\r\n    \"custom_var_v4\": null,\r\n    \"custom_var_k5\": null,\r\n    \"custom_var_v5\": null,\r\n    \"contact_id\": null,\r\n    \"activity_detail_id\": null\r\n    },\r\n    {\r\n    \"conversion_id\": 0,\r\n    \"site_id\": 0,\r\n    \"visit_id\": 0,\r\n    \"visitor_id\": \"string\",\r\n    \"goal_id\": 0,\r\n    \"visit_action_id\": 0,\r\n    \"when_converted_utc\": \"2021-09-17T20:58:23Z\",\r\n    \"url_action_lookup_id\": 0,\r\n    \"url\": \"string\",\r\n    \"visitor_days_since_first\": 0,\r\n    \"visitor_returning\": false,\r\n    \"visitor_count_visits\": 0,\r\n    \"referer_keyword\": null,\r\n    \"referer_name\": null,\r\n    \"referer_type\": false,\r\n    \"custom_var_k1\": null,\r\n    \"custom_var_v1\": null,\r\n    \"custom_var_k2\": null,\r\n    \"custom_var_v2\": null,\r\n    \"custom_var_k3\": null,\r\n    \"custom_var_v3\": null,\r\n    \"custom_var_k4\": null,\r\n    \"custom_var_v4\": null,\r\n    \"custom_var_k5\": null,\r\n    \"custom_var_v5\": null,\r\n    \"contact_id\": null,\r\n    \"activity_detail_id\": null\r\n    }\r\n    ]\r\n    }\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>\r\n    {\r\n    \"code\": \"117\",\r\n    \"message\": \"No data found\"\r\n    }\r\n<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getconversionsforgoal\">Get conversions for goal<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/goals\/{goal_id}\/conversions<\/span><\/div>\n<p>\t\t\t\t\tRetrieve details of conversions assigned to your goal.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">goal_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot goal id.<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\"><span>conversion_id<\/span><span>site_id<\/span><span>visit_id<\/span><span>visitor_id<\/span><span>goal_id<\/span><span>visit_action_id<\/span><span>when_converted_utc<\/span><span>url_action_lookup_id<\/span><span>url<\/span><span>visitor_days_since_first<\/span><span>visitor_returning<\/span><span>visitor_count_visits<\/span><span>referer_keyword<\/span><span>referer_name<\/span><span>referer_type<\/span><span>custom_var_k1<\/span><span>custom_var_v1<\/span><span>custom_var_k2<\/span><span>custom_var_v2<\/span><span>custom_var_k3<\/span><span>custom_var_v3<\/span><span>custom_var_k4<\/span><span>custom_var_v4<\/span><span>custom_var_k5<\/span><span>custom_var_v5<\/span><span>contact_id<\/span><span>activity_detail_id<\/span><\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\"><span>site.site_id<\/span><span>site.name<\/span><span>site.main_url<\/span><span>site.created_date_utc<\/span><span>goal.goal_id<\/span><span>goal.site_id<\/span><span>goal.name<\/span><span>goal.match_attribute<\/span><span>goal.pattern<\/span><span>goal.pattern_type<\/span><span>goal.is_case_sensitive<\/span><span>goal.allow_multiple<\/span><span>goal.archived<\/span><span>goal.weighting_id<\/span><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 1000; maximum allowed value is 1000.<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is activity_date_utc descending.<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/goals\/{goal_id}\/conversions\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>\r\n    {\r\n    \"trackerConversions\": [\r\n    {\r\n    \"conversion_id\": 0,\r\n    \"site_id\": 0,\r\n    \"visit_id\": 0,\r\n    \"visitor_id\": \"string\",\r\n    \"goal_id\": 0,\r\n    \"visit_action_id\": 0,\r\n    \"when_converted_utc\": \"2021-09-17T20:58:23Z\",\r\n    \"url_action_lookup_id\": 0,\r\n    \"url\": \"string\",\r\n    \"visitor_days_since_first\": 0,\r\n    \"visitor_returning\": false,\r\n    \"visitor_count_visits\": 0,\r\n    \"referer_keyword\": null,\r\n    \"referer_name\": null,\r\n    \"referer_type\": false,\r\n    \"custom_var_k1\": null,\r\n    \"custom_var_v1\": null,\r\n    \"custom_var_k2\": null,\r\n    \"custom_var_v2\": null,\r\n    \"custom_var_k3\": null,\r\n    \"custom_var_v3\": null,\r\n    \"custom_var_k4\": null,\r\n    \"custom_var_v4\": null,\r\n    \"custom_var_k5\": null,\r\n    \"custom_var_v5\": null,\r\n    \"contact_id\": null,\r\n    \"activity_detail_id\": null\r\n    },\r\n    {\r\n    \"conversion_id\": 0,\r\n    \"site_id\": 0,\r\n    \"visit_id\": 0,\r\n    \"visitor_id\": \"string\",\r\n    \"goal_id\": 0,\r\n    \"visit_action_id\": 0,\r\n    \"when_converted_utc\": \"2021-09-17T20:58:23Z\",\r\n    \"url_action_lookup_id\": 0,\r\n    \"url\": \"string\",\r\n    \"visitor_days_since_first\": 0,\r\n    \"visitor_returning\": false,\r\n    \"visitor_count_visits\": 0,\r\n    \"referer_keyword\": null,\r\n    \"referer_name\": null,\r\n    \"referer_type\": false,\r\n    \"custom_var_k1\": null,\r\n    \"custom_var_v1\": null,\r\n    \"custom_var_k2\": null,\r\n    \"custom_var_v2\": null,\r\n    \"custom_var_k3\": null,\r\n    \"custom_var_v3\": null,\r\n    \"custom_var_k4\": null,\r\n    \"custom_var_v4\": null,\r\n    \"custom_var_k5\": null,\r\n    \"custom_var_v5\": null,\r\n    \"contact_id\": null,\r\n    \"activity_detail_id\": null\r\n    }\r\n    ]\r\n    }\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>\r\n    {\r\n    \"code\": \"117\",\r\n    \"message\": \"No data found\"\r\n    }\r\n<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div id=\"workflows\" class=\"section\">\n<h3>Workflows<\/h3>\n<p>Your StoneShot marketing automation workflows can be managed and queried.<\/p>\n<div class=\"method\">\n<h4 id=\"getworkflows\">Get workflows<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/workflows<\/span><\/div>\n<p>Retrieve workflows associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>workflow_id<\/span><span>name<\/span><span>status<\/span><span>description<\/span><span>created_date_utc<\/span><span>modified_date_utc<\/span><span>last_start_date_utc<\/span><span>last_end_date_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>list_id<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 100; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is workflow_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">name<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Restrict results based on the workflow name.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/workflows\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"workflows\": [\r\n    {\r\n      \"workflow_id\": 0,\r\n      \"status\": boolean,\r\n      \"name\": \"string\",\r\n      \"description\": \"string\",\r\n      \"created_date_utc\": \"2020-09-15T15:19:45Z\",\r\n      \"modified_date_utc\": \"2020-09-29T11:47:56Z\",\r\n      \"last_start_date_utc\": \"2020-09-29T11:47:56Z\",\r\n      \"last_end_date_utc\": \"2020-09-29T11:47:56Z\"\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getworkflow\">Get workflow<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/workflows\/{workflow_id}<\/span><\/div>\n<p>Retrieve specific workflow associated with your account.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">workflow_id<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">The unique StoneShot workflow id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-2\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-10\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>workflow_id<\/span><span>name<\/span><span>status<\/span><span>description<\/span><span>created_date_utc<\/span><span>modified_date_utc<\/span><span>last_start_date_utc<\/span><span>last_end_date_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>list_id<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/workflows\/[workflow_id]\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"workflow\": {\r\n    \"workflow_id\": 0,\r\n    \"status\": boolean,\r\n    \"name\": \"string\",\r\n    \"description\": \"string\",\r\n    \"created_date_utc\": \"2020-09-15T15:19:45Z\",\r\n    \"modified_date_utc\": \"2020-09-29T11:47:56Z\",\r\n    \"last_start_date_utc\": \"2020-09-29T11:47:56Z\",\r\n    \"last_end_date_utc\": \"2020-09-29T11:47:56Z\"\r\n  }\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"getworkflowcontacts\">Get workflow contacts<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">GET<\/span><span class=\"request-code\">\/workflows\/{workflow_id}\/contacts<\/span><\/div>\n<p>Retrieve contacts associated to a specific workflow.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">workflow_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot workflow id.<\/div>\n<\/div><\/div>\n<h5>Query parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">select<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.<\/div>\n<div class=\"available-fields-title\">Default fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>email<\/span><span>title<\/span><span>first_name<\/span><span>last_name<\/span><span>company<\/span><span>create_date_utc<\/span><span>contact_id<\/span><span>last_active_utc<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<div class=\"available-fields-title\">Other fields<\/div>\n<div class=\"available-fields\">\n\t\t\t\t\t\t\t\t\t<span>middle_name<\/span><span>website<\/span><span>job_title<\/span><span>telephone<\/span><span>telephone_ext<\/span><span>fax<\/span><span>mobile_number<\/span><span>home_number<\/span><span>address_1<\/span><span>address_2<\/span><span>address_3<\/span><span>address_4<\/span><span>city<\/span><span>county<\/span><span>postcode<\/span><span>country<\/span><span>opt_in<\/span><span>custom_1<\/span><span>custom_2<\/span><span>custom_3<\/span><span>custom_4<\/span><span>custom_5<\/span><span>custom_6<\/span><span>custom_7<\/span><span>custom_8<\/span><span>custom_9<\/span><span>custom_10<\/span><span>custom_11<\/span><span>custom_12<\/span><span>prefer_html<\/span><span>create_date_utc<\/span><span>is_bounce<\/span><span>salesforce_account_id<\/span><span>salesforce_owner_id<\/span><span>double_opt_in_status<\/span><span>unique_user_id<\/span><span>salesforce_id<\/span><span>siebel_id<\/span><span>dynamics_id<\/span><span>segments.segment_id<\/span><span>segments.name<\/span><span>segments.segmentation.name<\/span><span>segments.segmentation.segmentation_id<\/span><span>email_preferences.segment_id<\/span><span>email_preferences.name<\/span><span>email_preferences.segmentation.name<\/span><span>email_preferences.segmentation.segmentation_id<\/span><span>content_preferences.content_tag_id<\/span><span>content_preferences.tag.tag_id<\/span><span>content_preferences.tag.name<\/span><span>events.segment_id<\/span><span>events.name<\/span><span>events.segmentation.name<\/span><span>events.segmentation.segmentation_id<\/span><span>events.session.session_id<\/span><span>events.session.location<\/span><span>events.session.event.event_id<\/span><span>events.session.event.name<\/span><span>document_preferences.segment_id<\/span><span>document_preferences.name<\/span><span>document_preferences.segmentation.name<\/span><span>document_preferences.segmentation.segmentation_id<\/span><br \/>\n\t\t\t\t\t\t\t\t\t<span>custom_fields.value<\/span><span>custom_fields.custom_field.custom_field_id<\/span><span>custom_fields.custom_field.name<\/span><span>custom_fields.custom_field.display_name<\/span><span>contact_guid<\/span>\n\t\t\t\t\t\t\t\t<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">count<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to return. The default value is 1000; maximum allowed value is 1000.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">offset<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The number of records to be skipped. The default value is 0.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">sort_by<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The name of the field to sort by, include a &#8216;-&#8216; in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is contact_id descending.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">contact_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on a unique StoneShot contact id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact email address.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">first_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact first name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">last_name<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact last name.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">company<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact company.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">job_title<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact job title.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">city<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact city.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">county<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact county.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">country<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact country.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact salesforce id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact siebel id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">dynamics_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact microsoft dynamics id.<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">Restrict results based on contact unique external user id.<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X GET \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/workflows\/[workflow_id]\/contacts\" \\ \r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\"<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contacts\": [\r\n    {\r\n      \"contact_id\": 0,\r\n      \"email\": \"string\",\r\n      \"title\": \"string\",\r\n      \"first_name\": \"string\",\r\n      \"last_name\": \"string\",\r\n      \"company\": \"string\",\r\n      \"create_date_utc\": \"2019-06-13T15:00:45Z\",\r\n      \"last_active_utc\": \"2020-08-06T15:03:10Z\"\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"116\",\r\n  \"message\": \"Invalid sort_by field. Please check your input\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"addcontacttoworkflow\">Add contact to workflow<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">PATCH<\/span><span class=\"request-code\">\/workflows\/{workflow_id}\/contacts\/add<\/span><\/div>\n<p>Add a contact to a specific workflow.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">workflow_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot workflow id.<\/div>\n<\/div><\/div>\n<h5>Body parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">member_url_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact member url (optional)<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact salesforce id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">dynamics_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact microsoft dynamics id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact siebel id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact unique external user id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">contact_id<\/span><span class=\"parameter-type\">integer<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot contact id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact email address (optional).<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X PATCH \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/workflows\/[workflow_id]\/contacts\/add\"\r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\" \\\r\n\t-H \"Content-Type: application\/JSON\" \\\r\n  -d '{\"email\": \"string\"}'\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contacts\": [\r\n    {\r\n      \"contact_id\": 0,\r\n      \"email\": \"string\",\r\n      \"title\": \"string\",\r\n      \"first_name\": \"string\",\r\n      \"last_name\": \"string\",\r\n      \"company\": \"string\",\r\n      \"create_date_utc\": \"2017-07-27T17:34:51Z\"\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<div class=\"method\">\n<h4 id=\"removecontactfromworkflow\">Remove contact from workflow<\/h4>\n<p class=\"more\">More <i class=\"fas fa-chevron-down\"><\/i><\/p>\n<p class=\"less\">Less <i class=\"fas fa-chevron-up\"><\/i><\/p>\n<div class=\"request-line\"><span class=\"request-verb\">PATCH<\/span><span class=\"request-code\">\/workflows\/{workflow_id}\/contacts\/remove<\/span><\/div>\n<p>Remove a contact from a specific workflow.<\/p>\n<div class=\"method-detail\">\n<h5>Path parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">workflow_id<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot workflow id.<\/div>\n<\/div><\/div>\n<h5>Body parameters<\/h5>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">member_url_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact member url (optional)<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">salesforce_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact salesforce id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">dynamics_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact microsoft dynamics id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">siebel_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact siebel id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">unique_user_id<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact unique external user id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">contact_id<\/span><span class=\"parameter-type\">integer<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The unique StoneShot contact id (optional).<\/div>\n<\/div><\/div>\n<div class=\"row param-wrap\">\n<div class=\"col-md-4\"><span class=\"parameter\">email<\/span><span class=\"parameter-type\">string<\/span><\/div>\n<div class=\"col-md-8\">\n<div class=\"request-item-desc\">The contact email address (optional).<\/div>\n<\/div><\/div>\n<h5>cURL example<\/h5>\n<div class=\"curl-example\">\n<pre><code>curl -L -X PATCH \\\r\n  \"https:\/\/api.stoneshot.com\/v1\/workflows\/[workflow_id]\/contacts\/remove\"\r\n  -H \"Authorization: Basic [PASSWORD_BASE_64_ENCODED]\" \\\r\n\t-H \"Content-Type: application\/JSON\" \\\r\n  -d '{\"email\": \"string\"}'\r\n<\/code><\/pre>\n<\/p><\/div>\n<h5>Success response<\/h5>\n<div class=\"success-response-example\">\n<pre><code>{\r\n  \"contacts\": [\r\n    {\r\n      \"contact_id\": 0,\r\n      \"email\": \"string\",\r\n      \"title\": \"string\",\r\n      \"first_name\": \"string\",\r\n      \"last_name\": \"string\",\r\n      \"company\": \"string\",\r\n      \"create_date_utc\": \"2017-07-27T17:34:51Z\"\r\n    }\r\n  ]\r\n}<\/code><\/pre>\n<\/p><\/div>\n<h5>Error response<\/h5>\n<div class=\"error-response-example\">\n<pre><code>{\r\n  \"code\": \"117\",\r\n  \"message\": \"No data found\"\r\n}<\/code><\/pre>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/div>\n<p><script>\n$(function () {\n    $(\".nav-parent\").click(function (t) {\n        t.preventDefault();\n        var e = $(this).attr(\"href\");\n        $(\"html,body\").animate({\n            scrollTop: $(e).offset().top\n        }, \"slow\")\n    }), $(\".nav-child\").click(function (t) {\n        t.preventDefault();\n        var e = $(this).attr(\"href\");\n        $(\"html,body\").animate({\n            scrollTop: $(e).offset().top - 100\n        }, \"slow\")\n    }), $(\".matching-anchor\").click(function (t) {\n        t.preventDefault();\n        var e = $(this).attr(\"href\");\n        $(\"html,body\").animate({\n            scrollTop: $(e).offset().top - 100\n        }, \"slow\")\n    }), $(\".more\").on(\"click\", function () {\n        $(this).next().next().next().next().show(), $(this).hide(), $(this).next().show()\n    }), $(\".less\").on(\"click\", function () {\n        $(this).next().next().next().hide(), $(this).hide(), $(this).prev().show()\n    })\n});\n<\/script><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Getting started Authentication Requests Response status codes Rate limiting Contact matching Campaigns Get campaigns Get campaign Get campaign contacts Get campaign sends Get campaign opens Get contact campaign opens Get campaign clicks Get contact campaign clicks Get campaign links Get campaign unsubscribes Add contact to campaign Contacts Get contacts Create contact Get contact Update contact [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"class_list":["post-13476","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v26.2 (Yoast SEO v27.4) - https:\/\/yoast.com\/product\/yoast-seo-premium-wordpress\/ -->\n<title>API Documentation - The Learning Site<\/title>\n<meta name=\"description\" content=\"Integrate StoneShot data with your website to implement smarter marketing strategies and give your clients a personalised experience.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.stoneshot.com\/learn\/api-documentation\/\" \/>\n<meta property=\"og:locale\" content=\"en_GB\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"API Documentation\" \/>\n<meta property=\"og:description\" content=\"Integrate StoneShot data with your website to implement smarter marketing strategies and give your clients a personalised experience.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.stoneshot.com\/learn\/api-documentation\/\" \/>\n<meta property=\"og:site_name\" content=\"The Learning Site\" \/>\n<meta property=\"article:modified_time\" content=\"2026-02-23T16:11:06+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:site\" content=\"@StoneShot\" \/>\n<meta name=\"twitter:label1\" content=\"Estimated reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"53 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/api-documentation\\\/\",\"url\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/api-documentation\\\/\",\"name\":\"API Documentation - The Learning Site\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/#website\"},\"datePublished\":\"2023-01-10T12:03:45+00:00\",\"dateModified\":\"2026-02-23T16:11:06+00:00\",\"description\":\"Integrate StoneShot data with your website to implement smarter marketing strategies and give your clients a personalised experience.\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/api-documentation\\\/#breadcrumb\"},\"inLanguage\":\"en-GB\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/api-documentation\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/api-documentation\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Documentation\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/#website\",\"url\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/\",\"name\":\"StoneShot Learning\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-GB\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/#organization\",\"name\":\"The Learning Site\",\"url\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-GB\",\"@id\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/wp-content\\\/uploads\\\/2022\\\/10\\\/mob-logo.svg\",\"contentUrl\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/wp-content\\\/uploads\\\/2022\\\/10\\\/mob-logo.svg\",\"width\":32,\"height\":32,\"caption\":\"The Learning Site\"},\"image\":{\"@id\":\"https:\\\/\\\/www.stoneshot.com\\\/learn\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"https:\\\/\\\/x.com\\\/StoneShot\"]}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"API Documentation - The Learning Site","description":"Integrate StoneShot data with your website to implement smarter marketing strategies and give your clients a personalised experience.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.stoneshot.com\/learn\/api-documentation\/","og_locale":"en_GB","og_type":"article","og_title":"API Documentation","og_description":"Integrate StoneShot data with your website to implement smarter marketing strategies and give your clients a personalised experience.","og_url":"https:\/\/www.stoneshot.com\/learn\/api-documentation\/","og_site_name":"The Learning Site","article_modified_time":"2026-02-23T16:11:06+00:00","twitter_card":"summary_large_image","twitter_site":"@StoneShot","twitter_misc":{"Estimated reading time":"53 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.stoneshot.com\/learn\/api-documentation\/","url":"https:\/\/www.stoneshot.com\/learn\/api-documentation\/","name":"API Documentation - The Learning Site","isPartOf":{"@id":"https:\/\/www.stoneshot.com\/learn\/#website"},"datePublished":"2023-01-10T12:03:45+00:00","dateModified":"2026-02-23T16:11:06+00:00","description":"Integrate StoneShot data with your website to implement smarter marketing strategies and give your clients a personalised experience.","breadcrumb":{"@id":"https:\/\/www.stoneshot.com\/learn\/api-documentation\/#breadcrumb"},"inLanguage":"en-GB","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.stoneshot.com\/learn\/api-documentation\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.stoneshot.com\/learn\/api-documentation\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.stoneshot.com\/learn\/"},{"@type":"ListItem","position":2,"name":"API Documentation"}]},{"@type":"WebSite","@id":"https:\/\/www.stoneshot.com\/learn\/#website","url":"https:\/\/www.stoneshot.com\/learn\/","name":"StoneShot Learning","description":"","publisher":{"@id":"https:\/\/www.stoneshot.com\/learn\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.stoneshot.com\/learn\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-GB"},{"@type":"Organization","@id":"https:\/\/www.stoneshot.com\/learn\/#organization","name":"The Learning Site","url":"https:\/\/www.stoneshot.com\/learn\/","logo":{"@type":"ImageObject","inLanguage":"en-GB","@id":"https:\/\/www.stoneshot.com\/learn\/#\/schema\/logo\/image\/","url":"https:\/\/www.stoneshot.com\/learn\/wp-content\/uploads\/2022\/10\/mob-logo.svg","contentUrl":"https:\/\/www.stoneshot.com\/learn\/wp-content\/uploads\/2022\/10\/mob-logo.svg","width":32,"height":32,"caption":"The Learning Site"},"image":{"@id":"https:\/\/www.stoneshot.com\/learn\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/x.com\/StoneShot"]}]}},"_links":{"self":[{"href":"https:\/\/www.stoneshot.com\/learn\/wp-json\/wp\/v2\/pages\/13476","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.stoneshot.com\/learn\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.stoneshot.com\/learn\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.stoneshot.com\/learn\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.stoneshot.com\/learn\/wp-json\/wp\/v2\/comments?post=13476"}],"version-history":[{"count":79,"href":"https:\/\/www.stoneshot.com\/learn\/wp-json\/wp\/v2\/pages\/13476\/revisions"}],"predecessor-version":[{"id":15086,"href":"https:\/\/www.stoneshot.com\/learn\/wp-json\/wp\/v2\/pages\/13476\/revisions\/15086"}],"wp:attachment":[{"href":"https:\/\/www.stoneshot.com\/learn\/wp-json\/wp\/v2\/media?parent=13476"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}