{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/applicants/booked_slots","auth":"required","settings":"","results":{"codes":[{"name":"","code":"[\n  {\n    \"applicant_id\": \"7f4e0af3-d0a3-4003-82c5-07dbf810a0b9\",\n       \"booked_slots\": [\n           {\n               \"id\": \"4e8c4b89-3b33-4524-b228-8ee2c66a4192\",\n               \"start_time\": \"2021-06-03T00:30:00Z\",\n               \"end_time\": \"2021-06-03T01:00:00Z\",\n               \"location\": \"Rest\",\n               \"recruiter\": \"Alice Guest\",\n               \"instructions\": \"Rest\",\n               \"showed_up\": null,\n               \"stage_title\": \"Scheduler\",\n               \"booked_time\": \"2021-06-02T11:26:06Z\"\n           },\n           {\n               \"id\": \"56084c36-6a6a-4946-b97e-52afc0053d3d\",\n               \"start_time\": \"2021-06-03T00:30:00Z\",\n               \"end_time\": \"2021-06-03T01:00:00Z\",\n               \"location\": \"Rest\",\n               \"recruiter\": \"Alice Guest\",\n               \"instructions\": \"Rest\",\n               \"showed_up\": null,\n               \"stage_title\": \"Scheduler\",\n               \"booked_time\": \"2021-06-02T13:03:47Z\"\n           }\n        ]\n  },\n  {\n    \"applicant_id\": \"e18583a0-9d09-930e-dff4-1bf8fc26d0d0\",\n       \"booked_slots\": [\n           {\n               \"id\": \"8d1b8c14-3698-4078-a41e-1cf645c0cee1\",\n               \"start_time\": \"2021-02-24T00:30:00Z\",\n               \"end_time\": \"2021-02-24T02:00:00Z\",\n               \"location\": \"Zoom\",\n               \"recruiter\": \"James Warren\",\n               \"instructions\": \"Text\",\n               \"showed_up\": true,\n               \"stage_title\": \"Interview\",\n               \"booked_time\": \"2021-02-20T11:26:06Z\"\n           },\n           {\n               \"id\": \"b9dfb1e7-09bd-4d4b-ae16-4f250d1b5b0f\",\n               \"start_time\": \"2021-06-03T00:30:00Z\",\n               \"end_time\": \"2021-06-03T01:00:00Z\",\n               \"location\": \"Zoom\",\n               \"recruiter\": \"Amber Sauce\",\n               \"instructions\": \"Call\",\n               \"showed_up\": null,\n               \"stage_title\": \"Interview\",\n               \"booked_time\": \"2021-04-02T13:03:47Z\"\n            }\n        ]\n    }\n]","language":"json","status":200}]},"params":[{"name":"ids","type":"array_string","default":"{   \"ids\": [     \"7f4e0af3-d0a3-4003-82c5-07dbf810a0b9\",     \"e18583a0-9d09-930e-dff4-1bf8fc26d0d0”   ] }","desc":"List of applicant IDs (limit of 1000)","required":false,"in":"path","ref":"","_id":"60b04f076ebbea00230d062b"},{"name":"X-ACCESS-TOKEN","type":"string","default":"secret-api-token","desc":"Access Token","required":true,"in":"header","ref":"","_id":"60be32fcc968f1004665275d"}],"examples":{"codes":[{"code":"curl -X POST -H \"Content-Type: application/json\" -H \"X-ACCESS-TOKEN:aaabbbcccddd111222333444\" \"https://api.fountain.com/v2/applicants/booked_slots\" -d '{\"ids\": [\"7f4e0af3-d0a3-4003-82c5-07dbf810a0b9\", \"e18583a0-9d09-930e-dff4-1bf8fc26d0d0\"]}'","language":"curl","name":"cURL"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Get Interview Sessions for Multiple Applicants","type":"endpoint","slug":"interview-sessions-for-multiple-applicants","excerpt":"","body":"This endpoint retrieves all booked interview sessions for every applicant specified within your account, starting from the creation of each applicant. You will get information about each of the interview sessions - start/end time, location, name of interviewing recruiter, interview instructions, etc.\n\nYou can search for up to 1000 applicants at once.\n\n\n# Response Schema\nType: array\n  * applicant_id (string)\n    * Unique identifier for each individual applicant\n  * booked_slots (array)\n    * id (string)\n      * Unique identifier for each individual interview session\n    * start_time (string)\n      * Starting date and time for the interview\n    * end_time (string)\n      * Ending date and time for the interview\n    * location (string)\n      * Location of the interview. Can be physical or virtual.\n    * recruiter (string)\n      * Name of the recruiter interviewing the applicant.\n    * instructions (string)\n      * Additional instructions provided to the applicant\n    * showed_up (boolean)\n      * `true` if the applicant attended the interview. `false` if the applicant did not.\n    * stage_title (string)\n      * Name of the interview stage within the Fountain workflow\n    * booked_time (string)\n      * Date and time logged when the interview was scheduled","updates":[],"order":14,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60b0480a222d9a007bfcff6f","createdAt":"2021-05-28T01:31:54.401Z","user":"547504ed59fade080004cb8b","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Applicant Management","slug":"endpoints","order":2,"from_sync":false,"reference":false,"_id":"59de6011debd1200240f68fa","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","__v":0,"createdAt":"2016-02-19T01:01:16.044Z"},"version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z"},"project":"59de6011debd1200240f68ec","__v":34,"parentDoc":null}

postGet Interview Sessions for Multiple Applicants


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ids:
array of strings{ "ids": [ "7f4e0af3-d0a3-4003-82c5-07dbf810a0b9", "e18583a0-9d09-930e-dff4-1bf8fc26d0d0” ] }
List of applicant IDs (limit of 1000)

Headers

X-ACCESS-TOKEN:
required
stringsecret-api-token
Access Token

Examples


Result Format


Documentation

This endpoint retrieves all booked interview sessions for every applicant specified within your account, starting from the creation of each applicant. You will get information about each of the interview sessions - start/end time, location, name of interviewing recruiter, interview instructions, etc. You can search for up to 1000 applicants at once. # Response Schema Type: array * applicant_id (string) * Unique identifier for each individual applicant * booked_slots (array) * id (string) * Unique identifier for each individual interview session * start_time (string) * Starting date and time for the interview * end_time (string) * Ending date and time for the interview * location (string) * Location of the interview. Can be physical or virtual. * recruiter (string) * Name of the recruiter interviewing the applicant. * instructions (string) * Additional instructions provided to the applicant * showed_up (boolean) * `true` if the applicant attended the interview. `false` if the applicant did not. * stage_title (string) * Name of the interview stage within the Fountain workflow * booked_time (string) * Date and time logged when the interview was scheduled

User Information

Try It Out

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