{"_id":"59de6011debd1200240f6923","parentDoc":null,"user":"547504ed59fade080004cb8b","category":{"_id":"59de6011debd1200240f68f8","__v":0,"project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-22T07:01:46.643Z","from_sync":false,"order":6,"slug":"available-slots-management","title":"Session and Slot Management"},"project":"59de6011debd1200240f68ec","version":{"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z","categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"__v":4,"githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-22T17:50:42.204Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X GET -d 'api_token=secret-api-token' 'https://api.fountain.com/v2/stages/01234567-0000-0000-0000-000000000000/available_slots'"}]},"method":"get","results":{"codes":[{"language":"json","code":"{\n  \"slots\": [\n    {\n      \"id\": \"21d7d019-7940-44d1-a710-0a79dd71cfcd\",\n      \"location\": \"Stoltenbergburgh\",\n      \"start_time\": \"Wed, Jun 03 :::at:::11:27am PDT\",\n      \"end_time\": \"Wed, Jun 03 @11:27am PDT\",\n       \"recruiter\": \"John Doe\",\n      \"max_attendees\": 5,\n      \"booked_slots_count\": 3\n    }\n  ],\n  \"pagination\": {\n    \"first\": 1,\n    \"previous\": \"\",\n    \"current\": 1,\n    \"next\": \"\",\n    \"last\": 1\n  }\n}","name":"","status":200},{"status":401,"language":"json","code":"{\n  \"message\": \"Authentication is required\"\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"56cb4a720549f0130068ded7","ref":"","in":"path","required":false,"desc":"stage_id must be passed in as URL parameter","default":"01234567-0000-0000-0000-000000000000","type":"string","name":"stage_id"},{"_id":"56cb4a720549f0130068ded6","ref":"","in":"query","required":false,"desc":"required if not passed in through header","default":"secret-api-token","type":"string","name":"api_token"}],"url":"/stages/:stage_id/available_slots"},"isReference":false,"order":1,"body":"This method lists all the available slots.\n\nUse pagination to browse through all the slots.\n\nUse the `page` parameter to indicate the page for pagination, e.g. `&page=2` to get to the 2nd page of the listing. \n\n## Response Schema\n\n[block:html]\n{\n  \"html\": \"<ul>\\n   <li>additionalProperties: false</li>\\n   <li>\\n      <span id=\\\"slots-0-3325553877613197440\\\">\\n      <a href=\\\"#slots-0-3325553877613197440\\\" class=\\\"anchor\\\">\\n      <tt>slots</tt>\\n      </a>\\n      </span>\\n      <div class=\\\"schema\\\">\\n         <ul>\\n            <li>Required: no</li>\\n            <li>Type: array</li>\\n            <li>\\n               Items\\n               <div class=\\\"schema\\\">\\n                  <ul>\\n                     <li>Required: no</li>\\n                     <li>additionalProperties: false</li>\\n                     <li>\\n                        <span id=\\\"id-2--2444276176594883772\\\">\\n                        <a href=\\\"#id-2--2444276176594883772\\\" class=\\\"anchor\\\">\\n                        <tt>id</tt>\\n                        </a>\\n                        </span>\\n                        <div class=\\\"schema\\\">\\n                           <ul>\\n                              <li>Required: no</li>\\n                              <li>Type: string</li>\\n                              <li>Example: <tt>\\\"21d7d019-7940-44d1-a710-0a79dd71cfcd\\\"</tt></li>\\n                           </ul>\\n                        </div>\\n                     </li>\\n                     <li>\\n                        <span id=\\\"location-2-3324822916068000712\\\">\\n                        <a href=\\\"#location-2-3324822916068000712\\\" class=\\\"anchor\\\">\\n                        <tt>location</tt>\\n                        </a>\\n                        </span>\\n                        <div class=\\\"schema\\\">\\n                           <ul>\\n                              <li>Required: no</li>\\n                              <li>Type: string</li>\\n                              <li>Example: <tt>\\\"Stoltenbergburgh\\\"</tt></li>\\n                           </ul>\\n                        </div>\\n                     </li>\\n                     <li>\\n                        <span id=\\\"start_time-2--4171748757092122220\\\">\\n                        <a href=\\\"#start_time-2--4171748757092122220\\\" class=\\\"anchor\\\">\\n                        <tt>start_time</tt>\\n                        </a>\\n                        </span>\\n                        <div class=\\\"schema\\\">\\n                           <ul>\\n                              <li>Required: no</li>\\n                              <li>Type: string</li>\\n                              <li>Example: <tt>\\\"Wed, Jun 03 @11:27am PDT\\\"</tt></li>\\n                           </ul>\\n                        </div>\\n                     </li>\\n                     <li>\\n                        <span id=\\\"end_time-2-179778401837983444\\\">\\n                        <a href=\\\"#end_time-2-179778401837983444\\\" class=\\\"anchor\\\">\\n                        <tt>end_time</tt>\\n                        </a>\\n                        </span>\\n                        <div class=\\\"schema\\\">\\n                           <ul>\\n                              <li>Required: no</li>\\n                              <li>Type: string</li>\\n                              <li>Example: <tt>\\\"Wed, Jun 03 @11:47am PDT\\\"</tt></li>\\n                           </ul>\\n                        </div>\\n                     </li>\\n                     <li>\\n                        <span id=\\\"end_time-2-179778401837983444\\\">\\n                        <a href=\\\"#end_time-2-179778401837983444\\\" class=\\\"anchor\\\">\\n                        <tt>recruiter</tt>\\n                        </a>\\n                        </span>\\n                        <div class=\\\"schema\\\">\\n                           <ul>\\n                              <li>Required: no</li>\\n                              <li>Type: string</li>\\n                              <li>Example: <tt>\\\"John Doe\\\"</tt></li>\\n                           </ul>\\n                        </div>\\n                     </li>\\n                     <li>\\n                        <span id=\\\"end_time-2-179778401837983444\\\">\\n                        <a href=\\\"#end_time-2-179778401837983444\\\" class=\\\"anchor\\\">\\n                        <tt>max_attendees</tt>\\n                        </a>\\n                        </span>\\n                        <div class=\\\"schema\\\">\\n                           <ul>\\n                              <li>Required: no</li>\\n                              <li>Type: string</li>\\n                              <li>Example: <tt>\\\"3\\\"</tt></li>\\n                           </ul>\\n                        </div>\\n                     </li>\\n                  </ul>\\n               </div>\\n            </li>\\n         </ul>\\n      </div>\\n   </li>\\n   <li>\\n      <span id=\\\"pagination-0-3040482953214710512\\\">\\n      <a href=\\\"#pagination-0-3040482953214710512\\\" class=\\\"anchor\\\">\\n      <tt>booked_slots_count</tt>\\n      </a>\\n      </span>\\n      <div class=\\\"schema\\\">\\n         <ul>\\n            <li>Required: no</li>\\n            <li>additionalProperties: false</li>\\n            <li>\\n               <span id=\\\"first-1-661913902263024780\\\">\\n               <a href=\\\"#first-1-661913902263024780\\\" class=\\\"anchor\\\">\\n               <tt>first</tt>\\n               </a>\\n               </span>\\n               <div class=\\\"schema\\\">\\n                  <ul>\\n                     <li>Required: no</li>\\n                     <li>Type: integer</li>\\n                     <li>Example: <tt>1</tt></li>\\n                  </ul>\\n               </div>\\n            </li>\\n            <li>\\n               <span id=\\\"previous-1-3611357421765080300\\\">\\n               <a href=\\\"#previous-1-3611357421765080300\\\" class=\\\"anchor\\\">\\n               <tt>previous</tt>\\n               </a>\\n               </span>\\n               <div class=\\\"schema\\\">\\n                  <ul>\\n                     <li>Required: no</li>\\n                     <li>Type: null</li>\\n                     <li>Example: <tt>\\\"\\\"</tt></li>\\n                  </ul>\\n               </div>\\n            </li>\\n            <li>\\n               <span id=\\\"current-1-3344545194894087836\\\">\\n               <a href=\\\"#current-1-3344545194894087836\\\" class=\\\"anchor\\\">\\n               <tt>current</tt>\\n               </a>\\n               </span>\\n               <div class=\\\"schema\\\">\\n                  <ul>\\n                     <li>Required: no</li>\\n                     <li>Type: integer</li>\\n                     <li>Example: <tt>1</tt></li>\\n                  </ul>\\n               </div>\\n            </li>\\n            <li>\\n               <span id=\\\"next-1-804580665650039876\\\">\\n               <a href=\\\"#next-1-804580665650039876\\\" class=\\\"anchor\\\">\\n               <tt>next</tt>\\n               </a>\\n               </span>\\n               <div class=\\\"schema\\\">\\n                  <ul>\\n                     <li>Required: no</li>\\n                     <li>Type: null</li>\\n                     <li>Example: <tt>\\\"\\\"</tt></li>\\n                  </ul>\\n               </div>\\n            </li>\\n            <li>\\n               <span id=\\\"last-1-1988642263870038660\\\">\\n               <a href=\\\"#last-1-1988642263870038660\\\" class=\\\"anchor\\\">\\n               <tt>last</tt>\\n               </a>\\n               </span>\\n               <div class=\\\"schema\\\">\\n                  <ul>\\n                     <li>Required: no</li>\\n                     <li>Type: integer</li>\\n                     <li>Example: <tt>1</tt></li>\\n                  </ul>\\n               </div>\\n            </li>\\n         </ul>\\n      </div>\\n   </li>\\n</ul>\"\n}\n[/block]","excerpt":"","slug":"list-available-slots","type":"endpoint","title":"List Available Slots"}

getList Available Slots


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

stage_id:
string01234567-0000-0000-0000-000000000000
stage_id must be passed in as URL parameter

Query Params

api_token:
stringsecret-api-token
required if not passed in through header

Examples


Result Format


Documentation

This method lists all the available slots. Use pagination to browse through all the slots. Use the `page` parameter to indicate the page for pagination, e.g. `&page=2` to get to the 2nd page of the listing. ## Response Schema [block:html] { "html": "<ul>\n <li>additionalProperties: false</li>\n <li>\n <span id=\"slots-0-3325553877613197440\">\n <a href=\"#slots-0-3325553877613197440\" class=\"anchor\">\n <tt>slots</tt>\n </a>\n </span>\n <div class=\"schema\">\n <ul>\n <li>Required: no</li>\n <li>Type: array</li>\n <li>\n Items\n <div class=\"schema\">\n <ul>\n <li>Required: no</li>\n <li>additionalProperties: false</li>\n <li>\n <span id=\"id-2--2444276176594883772\">\n <a href=\"#id-2--2444276176594883772\" class=\"anchor\">\n <tt>id</tt>\n </a>\n </span>\n <div class=\"schema\">\n <ul>\n <li>Required: no</li>\n <li>Type: string</li>\n <li>Example: <tt>\"21d7d019-7940-44d1-a710-0a79dd71cfcd\"</tt></li>\n </ul>\n </div>\n </li>\n <li>\n <span id=\"location-2-3324822916068000712\">\n <a href=\"#location-2-3324822916068000712\" class=\"anchor\">\n <tt>location</tt>\n </a>\n </span>\n <div class=\"schema\">\n <ul>\n <li>Required: no</li>\n <li>Type: string</li>\n <li>Example: <tt>\"Stoltenbergburgh\"</tt></li>\n </ul>\n </div>\n </li>\n <li>\n <span id=\"start_time-2--4171748757092122220\">\n <a href=\"#start_time-2--4171748757092122220\" class=\"anchor\">\n <tt>start_time</tt>\n </a>\n </span>\n <div class=\"schema\">\n <ul>\n <li>Required: no</li>\n <li>Type: string</li>\n <li>Example: <tt>\"Wed, Jun 03 @11:27am PDT\"</tt></li>\n </ul>\n </div>\n </li>\n <li>\n <span id=\"end_time-2-179778401837983444\">\n <a href=\"#end_time-2-179778401837983444\" class=\"anchor\">\n <tt>end_time</tt>\n </a>\n </span>\n <div class=\"schema\">\n <ul>\n <li>Required: no</li>\n <li>Type: string</li>\n <li>Example: <tt>\"Wed, Jun 03 @11:47am PDT\"</tt></li>\n </ul>\n </div>\n </li>\n <li>\n <span id=\"end_time-2-179778401837983444\">\n <a href=\"#end_time-2-179778401837983444\" class=\"anchor\">\n <tt>recruiter</tt>\n </a>\n </span>\n <div class=\"schema\">\n <ul>\n <li>Required: no</li>\n <li>Type: string</li>\n <li>Example: <tt>\"John Doe\"</tt></li>\n </ul>\n </div>\n </li>\n <li>\n <span id=\"end_time-2-179778401837983444\">\n <a href=\"#end_time-2-179778401837983444\" class=\"anchor\">\n <tt>max_attendees</tt>\n </a>\n </span>\n <div class=\"schema\">\n <ul>\n <li>Required: no</li>\n <li>Type: string</li>\n <li>Example: <tt>\"3\"</tt></li>\n </ul>\n </div>\n </li>\n </ul>\n </div>\n </li>\n </ul>\n </div>\n </li>\n <li>\n <span id=\"pagination-0-3040482953214710512\">\n <a href=\"#pagination-0-3040482953214710512\" class=\"anchor\">\n <tt>booked_slots_count</tt>\n </a>\n </span>\n <div class=\"schema\">\n <ul>\n <li>Required: no</li>\n <li>additionalProperties: false</li>\n <li>\n <span id=\"first-1-661913902263024780\">\n <a href=\"#first-1-661913902263024780\" class=\"anchor\">\n <tt>first</tt>\n </a>\n </span>\n <div class=\"schema\">\n <ul>\n <li>Required: no</li>\n <li>Type: integer</li>\n <li>Example: <tt>1</tt></li>\n </ul>\n </div>\n </li>\n <li>\n <span id=\"previous-1-3611357421765080300\">\n <a href=\"#previous-1-3611357421765080300\" class=\"anchor\">\n <tt>previous</tt>\n </a>\n </span>\n <div class=\"schema\">\n <ul>\n <li>Required: no</li>\n <li>Type: null</li>\n <li>Example: <tt>\"\"</tt></li>\n </ul>\n </div>\n </li>\n <li>\n <span id=\"current-1-3344545194894087836\">\n <a href=\"#current-1-3344545194894087836\" class=\"anchor\">\n <tt>current</tt>\n </a>\n </span>\n <div class=\"schema\">\n <ul>\n <li>Required: no</li>\n <li>Type: integer</li>\n <li>Example: <tt>1</tt></li>\n </ul>\n </div>\n </li>\n <li>\n <span id=\"next-1-804580665650039876\">\n <a href=\"#next-1-804580665650039876\" class=\"anchor\">\n <tt>next</tt>\n </a>\n </span>\n <div class=\"schema\">\n <ul>\n <li>Required: no</li>\n <li>Type: null</li>\n <li>Example: <tt>\"\"</tt></li>\n </ul>\n </div>\n </li>\n <li>\n <span id=\"last-1-1988642263870038660\">\n <a href=\"#last-1-1988642263870038660\" class=\"anchor\">\n <tt>last</tt>\n </a>\n </span>\n <div class=\"schema\">\n <ul>\n <li>Required: no</li>\n <li>Type: integer</li>\n <li>Example: <tt>1</tt></li>\n </ul>\n </div>\n </li>\n </ul>\n </div>\n </li>\n</ul>" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}