{"_id":"5c51d6df87bec403c27a9c63","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"},"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"},"user":"5c48cd9aa3db271af5836b81","__v":36,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-01-30T16:54:55.241Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"language":"json","code":"{\n   \"pagination\" : {\n      \"per_page\" : 10,\n      \"total_count\" : 2,\n      \"current_page\" : 1,\n      \"next_page\" : null,\n      \"total_pages\" : 1\n   },\n   \"sessions\" : [\n      {\n         \"end_time\" : \"2019-02-06T11:15:00.000-08:00\",\n         \"id\" : 27,\n         \"booked_slots_count\" : 1,\n         \"location\" : \"\",\n         \"start_time\" : \"2019-02-06T10:30:00.000-08:00\",\n         \"title\" : null,\n         \"date\" : \"2019-02-06\",\n         \"instructions\" : \"\",\n         \"user_id\" : 1,\n         \"max_attendees\" : 3,\n         \"stage_ids\" : [\n            \"df9cb534-5a18-47d7-99f5-13c5d8cc9ccc\"\n         ],\n         \"booked_slots\" : [\n            {\n               \"applicant_is_still_on_stage\" : true,\n               \"stage_title\" : \"In-person Interview\",\n               \"applicant_showed\" : null,\n               \"id\" : 4,\n               \"applicant\" : {\n                  \"email\" : \"jennings.torp:::at:::torphy.info\",\n                  \"phone_number\" : \"+-163-7169\",\n                  \"can_show\" : false,\n                  \"key\" : \"applicant-16\",\n                  \"id\" : 16,\n                  \"stage_title\" : \"In-person Interview\",\n                  \"name\" : \"Joanny Leuschke\",\n                  \"external_id\" : \"78b0745f-e69f-4623-964a-e1c8731b76e3\"\n               },\n               \"complete\" : false,\n               \"stage_id\" : 8\n            }\n         ],\n      },\n      {\n         \"stage_ids\" : [\n            \"df9cb534-5a18-47d7-99f5-13c5d8cc9ccc\"\n         ],\n         \"max_attendees\" : 3,\n         \"booked_slots\" : [\n            {\n               \"id\" : 5,\n               \"stage_id\" : 8,\n               \"complete\" : false,\n               \"applicant\" : {\n                  \"email\" : \"jerrold@beernikolaus.biz\",\n                  \"phone_number\" : \"+-153-3263\",\n                  \"can_show\" : false,\n                  \"key\" : \"applicant-9\",\n                  \"id\" : 9,\n                  \"stage_title\" : \"In-person Interview\",\n                  \"name\" : \"Nyah Schmidt\",\n                  \"external_id\" : \"1817beec-481a-432d-98f0-a8c986aec966\"\n               },\n               \"applicant_is_still_on_stage\" : true,\n               \"applicant_showed\" : null,\n               \"stage_title\" : \"In-person Interview\"\n            }\n         ],\n         \"date\" : \"2019-02-06\",\n         \"instructions\" : \"\",\n         \"user_id\" : 1,\n         \"booked_slots_count\" : 1,\n         \"location\" : \"\",\n         \"start_time\" : \"2019-02-06T11:15:00.000-08:00\",\n         \"title\" : null,\n         \"end_time\" : \"2019-02-06T12:00:00.000-08:00\",\n         \"id\" : 28\n      }\n   ],","name":"","status":200},{"status":401,"language":"json","code":"{\n  \"message\": \"Authentication is required\"\n}","name":""}]},"method":"get","examples":{"codes":[{"code":"curl -X GET -d 'api_token=secret-api-token&with_unbooked=true&funnel_id=11111111-0000-0000-0000-000000000000&stage_id=22222222-0000-0000-0000-000000000000' 'https://api.fountain.com/v2/sessions'","language":"curl"}]},"auth":"required","params":[{"_id":"56cb4a720549f0130068ded6","ref":"","in":"query","required":true,"desc":"required if not passed in through header","default":"secret-api-token","type":"string","name":"api_token"},{"_id":"5c5b526a412bba002578b50c","ref":"","in":"query","required":true,"desc":"Filter by Opening ID","default":"11111111-0000-0000-0000-000000000000","type":"string","name":"funnel_id"},{"_id":"5c7973c817a3220057fb7b5b","ref":"","in":"query","required":false,"desc":"Includes all available_slots when TRUE","default":"TRUE","type":"boolean","name":"with_unbooked"},{"_id":"5c5b526a412bba002578b50b","ref":"","in":"query","required":false,"desc":"Filter by Stage ID","default":"22222222-0000-0000-0000-000000000000","type":"string","name":"stage_id"},{"_id":"5c5b526a412bba002578b50a","ref":"","in":"query","required":false,"desc":"Cursor parameter for cursor-based pagination","default":"","type":"string","name":"cursor"}],"url":"/sessions"},"isReference":false,"order":4,"body":"## List Sessions\n\nList all sessions within your account. Pagination is available.\n\nYou can get all of the information about a session — including start time, end time, max attendees, as well as how many applicants booked that session and whether the booked applicants attended or not. \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\nHowever, the page parameter value has a limit due to performance reasons. If you need to access very old pages, please use cursor-based pagination. Every API response contains pagination.next_cursor property, which you can use as a `?cursor=<cursor_string>` in the next request. The parameter will look like this: `?cursor=cnNwcWJ4VWp1T0Y5eFZWSGIvUmZjdz09LS14Z1RZbGlCdmNRdHNJMEho...`.\n\n## Filtering\n\nThe Opening ID, or `funnel_id` is a required parameter for this endpoint. \n\nWe also support optional filters for selecting sessions from only the stages that you care about, by using the `stage_id` parameter. \n\nFor both the Opening and Stage ID, you must use the unique ID of the Stage or Opening, not the title. To look up the ID of an Opening (funnel) or Stage, use the `List All Positions` or `List All Stages` endpoints.\n\n## Booked or unbooked\nYou can return all the sessions, even those that are not yet booked, by passing `with_unbooked=true`. Otherwise, only booked sessions will be returned by default.","excerpt":"","slug":"sessions","type":"endpoint","title":"List Sessions"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

api_token:
required
stringsecret-api-token
required if not passed in through header
funnel_id:
required
string11111111-0000-0000-0000-000000000000
Filter by Opening ID
with_unbooked:
booleanTRUE
Includes all available_slots when TRUE
stage_id:
string22222222-0000-0000-0000-000000000000
Filter by Stage ID
cursor:
string
Cursor parameter for cursor-based pagination

Examples


Result Format


Documentation

## List Sessions List all sessions within your account. Pagination is available. You can get all of the information about a session — including start time, end time, max attendees, as well as how many applicants booked that session and whether the booked applicants attended or not. Use the `page` parameter to indicate the page for pagination, e.g. `&page=2` to get to the 2nd page of the listing. However, the page parameter value has a limit due to performance reasons. If you need to access very old pages, please use cursor-based pagination. Every API response contains pagination.next_cursor property, which you can use as a `?cursor=<cursor_string>` in the next request. The parameter will look like this: `?cursor=cnNwcWJ4VWp1T0Y5eFZWSGIvUmZjdz09LS14Z1RZbGlCdmNRdHNJMEho...`. ## Filtering The Opening ID, or `funnel_id` is a required parameter for this endpoint. We also support optional filters for selecting sessions from only the stages that you care about, by using the `stage_id` parameter. For both the Opening and Stage ID, you must use the unique ID of the Stage or Opening, not the title. To look up the ID of an Opening (funnel) or Stage, use the `List All Positions` or `List All Stages` endpoints. ## Booked or unbooked You can return all the sessions, even those that are not yet booked, by passing `with_unbooked=true`. Otherwise, only booked sessions will be returned by default.

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 }}