{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/analytics:fountain/applicants-list-all":{"get":{"operationId":"analytics_fountain_applicants_list_all","summary":"List All Applicants","description":"GET /v2/applicants","tags":["analytics"],"parameters":[{"name":"funnel_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"location_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"stage_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"stage","in":"query","required":false,"schema":{"type":"string"}},{"name":"labels","in":"query","required":false,"schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"created_at","in":"query","required":false,"schema":{"type":"string"}},{"name":"last_transitioned_at","in":"query","required":false,"schema":{"type":"string"}},{"name":"updated_at","in":"query","required":false,"schema":{"type":"string"}},{"name":"custom_data_field[key]","in":"query","required":false,"description":"The key of the custom data field to filter by. Used with `custom_data_field[value]`. Must also use one of created_at,…","schema":{"type":"string","description":"The key of the custom data field to filter by. Used with `custom_data_field[value]`. Must also use one of created_at,…"}},{"name":"custom_data_field[value]","in":"query","required":false,"description":"The value of the custom data field to filter by. Used with `custom_data_field[key]`.","schema":{"type":"string","description":"The value of the custom data field to filter by. Used with `custom_data_field[key]`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/applicants-create-new-applicant":{"post":{"operationId":"analytics_fountain_applicants_create_new_applicant","summary":"Create an Applicant","description":"POST /v2/applicants","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/applicants-get-info":{"get":{"operationId":"analytics_fountain_applicants_get_info","summary":"Get Applicant Info","description":"GET /v2/applicants/{id}","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/applicants-update-info":{"post":{"operationId":"analytics_fountain_applicants_update_info","summary":"Update Applicant Info","description":"PUT /v2/applicants/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/applicants-delete-by-id":{"post":{"operationId":"analytics_fountain_applicants_delete_by_id","summary":"Delete an Applicant","description":"DELETE /v2/applicants/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/applicants-advance-applicant":{"post":{"operationId":"analytics_fountain_applicants_advance_applicant","summary":"Advance an Applicant","description":"PUT /v2/applicants/{id}/advance","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/applicants-bulk-advance-multiple":{"post":{"operationId":"analytics_fountain_applicants_bulk_advance_multiple","summary":"Bulk Advance Multiple Applicants","description":"POST /v2/applicants/advance","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["stage_id"],"properties":{"stage_id":{"type":"string","description":"Destination stage's external id. All specified applicants will advance to this stage."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/applicants-get-transition-history":{"get":{"operationId":"analytics_fountain_applicants_get_transition_history","summary":"Get Transition History","description":"GET /v2/applicants/{id}/transitions","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"number"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/applicants-bulk-transition-history":{"post":{"operationId":"analytics_fountain_applicants_bulk_transition_history","summary":"Bulk Transition History for Multiple Applicants","description":"POST /v2/applicants/transitions","tags":["analytics"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/applicants-get-interview-sessions":{"get":{"operationId":"analytics_fountain_applicants_get_interview_sessions","summary":"Get Interview Sesssions","description":"GET /v2/applicants/{id}/booked_slots","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/applicants-bulk-interview-sessions":{"post":{"operationId":"analytics_fountain_applicants_bulk_interview_sessions","summary":"Bulk Interview Sessions for Multiple Applicants","description":"POST /v2/applicants/booked_slots","tags":["analytics"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/labels-list-for-applicant":{"get":{"operationId":"analytics_fountain_labels_list_for_applicant","summary":"List Labels for Applicant","description":"GET /v2/applicants/{id}/labels","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/labels-update-for-applicant":{"post":{"operationId":"analytics_fountain_labels_update_for_applicant","summary":"Update Label for Applicant","description":"PUT /v2/applicants/{id}/labels/{title}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","title"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"completed":{"type":"boolean"},"completed_at":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/notes-get-applicant":{"get":{"operationId":"analytics_fountain_notes_get_applicant","summary":"Get Applicant Notes","description":"GET /v2/applicants/{id}/notes","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/notes-create-applicant-note":{"post":{"operationId":"analytics_fountain_notes_create_applicant_note","summary":"Create Applicant Note","description":"POST /v2/applicants/{id}/notes","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/notes-update-applicant-note":{"post":{"operationId":"analytics_fountain_notes_update_applicant_note","summary":"Update Applicant Note","description":"PUT /v2/applicants/{id}/notes/{note_id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","note_id","body"],"properties":{"id":{"type":"string"},"note_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/notes-delete-applicant-note":{"post":{"operationId":"analytics_fountain_notes_delete_applicant_note","summary":"Delete Applicant Note","description":"DELETE /v2/applicants/{id}/notes/{note_id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","note_id"],"properties":{"id":{"type":"string"},"note_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/applicants-get-secure-documents":{"get":{"operationId":"analytics_fountain_applicants_get_secure_documents","summary":"Get Applicant Files","description":"GET /v2/applicants/{id}/secure_documents","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/applicants-upload-secure-document-to-s3":{"post":{"operationId":"analytics_fountain_applicants_upload_secure_document_to_s3","summary":"File Upload to S3","description":"POST /v2/applicants/{id}/secure_documents/upload","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/applicants-link-upload":{"post":{"operationId":"analytics_fountain_applicants_link_upload","summary":"Link Applicant to Files in S3","description":"POST /v2/applicants/{id}/secure_documents/link_upload","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/calendar-slots-create-new-available":{"post":{"operationId":"analytics_fountain_calendar_slots_create_new_available","summary":"Create Calendar Slots","description":"POST /v2/available_slots","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/calendar-slots-confirm-booking":{"post":{"operationId":"analytics_fountain_calendar_slots_confirm_booking","summary":"Book an Available Slot","description":"POST /v2/available_slots/{id}/confirm","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Available Slot ID"},"applicant_id":{"type":"string","description":"The unique identifier for the applicant to be associated with the booked slot"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/calendar-slots-destroy-by-id":{"post":{"operationId":"analytics_fountain_calendar_slots_destroy_by_id","summary":"Delete Calendar Slots","description":"DELETE /v2/available_slots/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Available Slot ID"},"delete_all_siblings":{"type":"boolean","description":"If set, will destroy all slots with the same key"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/calendar-slots-cancel-slot":{"post":{"operationId":"analytics_fountain_calendar_slots_cancel_slot","summary":"Cancel a booked slot","description":"POST /v2/booked_slots/{id}/cancel","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifier of the booked slot to cancel"},"page":{"type":"integer","description":"The page of results to view"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/data-keys-list":{"get":{"operationId":"analytics_fountain_data_keys_list","summary":"List data keys","description":"GET /v2/data_keys","tags":["analytics"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page of results to retrieve.","schema":{"type":"integer","description":"The page of results to retrieve."}},{"name":"per_page","in":"query","required":false,"description":"The number of results to retrieve per page. The endpoint returns 20 results per page by default.","schema":{"type":"integer","description":"The number of results to retrieve per page. The endpoint returns 20 results per page by default."}},{"name":"updated_at","in":"query","required":false,"description":"A filter to limit which data_keys will be returned based on the last_updated_at data on the data_key.","schema":{"type":"string","description":"A filter to limit which data_keys will be returned based on the last_updated_at data on the data_key."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/export-management-list-custom-exports":{"get":{"operationId":"analytics_fountain_export_management_list_custom_exports","summary":"List all Custom Exports","description":"GET /v2/exports","tags":["analytics"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/export-management-create-custom-export":{"post":{"operationId":"analytics_fountain_export_management_create_custom_export","summary":"Create Custom Export","description":"POST /v2/exports","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["template_id"],"properties":{"template_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/export-management-download-custom-export":{"get":{"operationId":"analytics_fountain_export_management_download_custom_export","summary":"Download Custom Export","description":"GET /v2/exports/{id}","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/export-management-list-custom-templates":{"get":{"operationId":"analytics_fountain_export_management_list_custom_templates","summary":"List all Custom Export Templates","description":"GET /v2/exports/templates","tags":["analytics"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/openings-and-stages-list-all":{"get":{"operationId":"analytics_fountain_openings_and_stages_list_all","summary":"List All Openings","description":"GET /v2/funnels","tags":["analytics"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page of results to view","schema":{"type":"integer","description":"The page of results to view"}},{"name":"per_page","in":"query","required":false,"description":"The number of results to return per page","schema":{"type":"integer","description":"The number of results to return per page"}},{"name":"sort_by","in":"query","required":false,"description":"The field by which to sort results","schema":{"type":"string","description":"The field by which to sort results"}},{"name":"sort_direction","in":"query","required":false,"description":"The direction in which results are sorted","schema":{"type":"string","enum":["asc","desc"],"description":"The direction in which results are sorted"}},{"name":"active","in":"query","required":false,"description":"Filter by whether the opening is active or not","schema":{"type":"boolean","description":"Filter by whether the opening is active or not"}},{"name":"brand_name","in":"query","required":false,"description":"Filter by the name of the brand","schema":{"type":"string","description":"Filter by the name of the brand"}},{"name":"location_address","in":"query","required":false,"description":"Filter by the address associated with the opening","schema":{"type":"string","description":"Filter by the address associated with the opening"}},{"name":"location_name","in":"query","required":false,"description":"Filter by the name of the location associated with the opening","schema":{"type":"string","description":"Filter by the name of the location associated with the opening"}},{"name":"location_group_name","in":"query","required":false,"description":"Filter by the name of the location group associated with the opening","schema":{"type":"string","description":"Filter by the name of the location group associated with the opening"}},{"name":"query","in":"query","required":false,"description":"Text-based query of the opening attributes","schema":{"type":"string","description":"Text-based query of the opening attributes"}},{"name":"shift_name","in":"query","required":false,"description":"Filter by the name of the shift associated with the opening","schema":{"type":"string","description":"Filter by the name of the shift associated with the opening"}},{"name":"shift_days[]","in":"query","required":false,"description":"Filter by the days of the shift associated with the opening","schema":{"type":"array","description":"Filter by the days of the shift associated with the opening"}},{"name":"shift_start_time","in":"query","required":false,"description":"Filter by the start time of the shift associated with the opening using the 24 hour clock (i.e. 10 PM is 2200)","schema":{"type":"string","description":"Filter by the start time of the shift associated with the opening using the 24 hour clock (i.e. 10 PM is 2200)"}},{"name":"shift_end_time","in":"query","required":false,"description":"Filter by the end time of the shift associated with the opening using the 24 hour clock (i.e. 10 PM is 2200)","schema":{"type":"string","description":"Filter by the end time of the shift associated with the opening using the 24 hour clock (i.e. 10 PM is 2200)"}},{"name":"sourcing_purchase_type","in":"query","required":false,"description":"Filter by the sourcing type of the opening","schema":{"type":"string","enum":["standard","indeed_campaign"],"description":"Filter by the sourcing type of the opening"}},{"name":"title","in":"query","required":false,"description":"Filter by the title of the opening","schema":{"type":"string","description":"Filter by the title of the opening"}},{"name":"updated_at_gt","in":"query","required":false,"description":"Filter for funnels updated after this","schema":{"type":"string","description":"Filter for funnels updated after this"}},{"name":"updated_at_lt","in":"query","required":false,"description":"Filter for funnels updated before this","schema":{"type":"string","description":"Filter for funnels updated before this"}},{"name":"user_openings","in":"query","required":false,"description":"Filter to account owner","schema":{"type":"boolean","description":"Filter to account owner"}},{"name":"workflow_id","in":"query","required":false,"description":"Filter for funnels with a specific workflow identifier","schema":{"type":"string","description":"Filter for funnels with a specific workflow identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/openings-and-stages-create-opening":{"post":{"operationId":"analytics_fountain_openings_and_stages_create_opening","summary":"Create a new opening","description":"POST /v2/funnels","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/openings-and-stages-get-opening-by-id":{"get":{"operationId":"analytics_fountain_openings_and_stages_get_opening_by_id","summary":"Retrieve Opening","description":"GET /v2/funnels/{id}","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"description":"The Opening ID","schema":{"type":"string","description":"The Opening ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/openings-and-stages-update-opening":{"post":{"operationId":"analytics_fountain_openings_and_stages_update_opening","summary":"Update opening","description":"PUT /v2/funnels/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The Opening ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/openings-and-stages-delete-opening":{"post":{"operationId":"analytics_fountain_openings_and_stages_delete_opening","summary":"Delete an opening","description":"DELETE /v2/funnels/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Opening ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/hiring-goals-list-goals":{"get":{"operationId":"analytics_fountain_hiring_goals_list_goals","summary":"List Hiring Goals","description":"GET /v2/hiring_goals","tags":["analytics"],"parameters":[{"name":"opening_id","in":"query","required":false,"description":"Filter by a particular Opening (also known as Funnel)","schema":{"type":"integer","description":"Filter by a particular Opening (also known as Funnel)"}},{"name":"page","in":"query","required":false,"description":"The page of results to view","schema":{"type":"integer","description":"The page of results to view"}},{"name":"per_page","in":"query","required":false,"description":"The number of results to return per page","schema":{"type":"integer","description":"The number of results to return per page"}},{"name":"sort_by","in":"query","required":false,"description":"The field by which to sort results","schema":{"type":"string","description":"The field by which to sort results"}},{"name":"sort_direction","in":"query","required":false,"description":"The direction in which results are sorted","schema":{"type":"string","enum":["asc","desc"],"description":"The direction in which results are sorted"}},{"name":"status","in":"query","required":false,"description":"Filter by the Hiring Goal status","schema":{"type":"string","enum":["unfilled","filled"],"description":"Filter by the Hiring Goal status"}},{"name":"current","in":"query","required":false,"description":"Filter to current Hiring Goals. Current is defined by Hiring Goals with a `hire_by` date greater and or equal to today.","schema":{"type":"boolean","description":"Filter to current Hiring Goals. Current is defined by Hiring Goals with a `hire_by` date greater and or equal to today."}},{"name":"past","in":"query","required":false,"description":"Filter to past Hiring Goals. Current is defined by Hiring Goals with a `hire_by` date before today.","schema":{"type":"boolean","description":"Filter to past Hiring Goals. Current is defined by Hiring Goals with a `hire_by` date before today."}},{"name":"open","in":"query","required":false,"description":"Filter to open Hiring Goals. Open Hiring Goals are Hiring Goals who have not been closed (`closed_at == nil`)","schema":{"type":"boolean","description":"Filter to open Hiring Goals. Open Hiring Goals are Hiring Goals who have not been closed (`closed_at == nil`)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/hiring-goals-create-new-goal":{"post":{"operationId":"analytics_fountain_hiring_goals_create_new_goal","summary":"Create a new hiring goal","description":"POST /v2/hiring_goals","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/hiring-goals-update-existing-goal":{"post":{"operationId":"analytics_fountain_hiring_goals_update_existing_goal","summary":"Update Hiring Goal","description":"PUT /v2/hiring_goals/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The Hiring Goal ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/hiring-goals-delete-goal":{"post":{"operationId":"analytics_fountain_hiring_goals_delete_goal","summary":"Delete a Hiring Goal","description":"DELETE /v2/hiring_goals/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Hiring Goal ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/locations-and-location-groups-list":{"get":{"operationId":"analytics_fountain_locations_and_location_groups_list","summary":"List Location Groups","description":"GET /v2/location_groups","tags":["analytics"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/locations-and-location-groups-create-location-group":{"post":{"operationId":"analytics_fountain_locations_and_location_groups_create_location_group","summary":"Create a new Location Group","description":"POST /v2/location_groups","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/locations-and-location-groups-get-location-group":{"get":{"operationId":"analytics_fountain_locations_and_location_groups_get_location_group","summary":"Retrieve Location Group","description":"GET /v2/location_groups/{id}","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"description":"The Location Group ID","schema":{"type":"string","description":"The Location Group ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/locations-and-location-groups-update-location-group":{"post":{"operationId":"analytics_fountain_locations_and_location_groups_update_location_group","summary":"Update Location Group","description":"PUT /v2/location_groups/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The Location Group ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/locations-and-location-groups-delete-location-group":{"post":{"operationId":"analytics_fountain_locations_and_location_groups_delete_location_group","summary":"Delete a Location Group","description":"DELETE /v2/location_groups/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Location Group ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/locations-and-location-groups-list-locations":{"get":{"operationId":"analytics_fountain_locations_and_location_groups_list_locations","summary":"List Locations","description":"GET /v2/locations","tags":["analytics"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/locations-and-location-groups-create-new-location":{"post":{"operationId":"analytics_fountain_locations_and_location_groups_create_new_location","summary":"Create a new Location","description":"POST /v2/locations","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/locations-and-location-groups-get-location-by-id":{"get":{"operationId":"analytics_fountain_locations_and_location_groups_get_location_by_id","summary":"Retrieve Location","description":"GET /v2/locations/{id}","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"description":"The Location ID","schema":{"type":"string","description":"The Location ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/locations-and-location-groups-update-location":{"post":{"operationId":"analytics_fountain_locations_and_location_groups_update_location","summary":"Update Location","description":"PUT /v2/locations/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The Location ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/locations-and-location-groups-delete-location":{"post":{"operationId":"analytics_fountain_locations_and_location_groups_delete_location","summary":"Delete a Location","description":"DELETE /v2/locations/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Location ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/openings-reassign-to-workflow":{"post":{"operationId":"analytics_fountain_openings_reassign_to_workflow","summary":"Reassign Opening to Different Workflow (Alpha)","description":"POST /api/v2/openings/workflow_reassignment","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/option-bank-get-option-bank-by-id":{"get":{"operationId":"analytics_fountain_option_bank_get_option_bank_by_id","summary":"Get Option Bank","description":"GET /v2/option_banks/{id}","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/option-bank-replace-bank":{"post":{"operationId":"analytics_fountain_option_bank_replace_bank","summary":"Replace Option Bank","description":"PUT /v2/option_banks/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/option-bank-delete-bank":{"post":{"operationId":"analytics_fountain_option_bank_delete_bank","summary":"Delete Option Bank","description":"DELETE /v2/option_banks/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/option-bank-remove-option":{"post":{"operationId":"analytics_fountain_option_bank_remove_option","summary":"Remove from Option Bank","description":"DELETE /v2/option_banks/{id}/remove","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","options"],"properties":{"id":{"type":"string"},"options":{"type":"object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/option-bank-append-option":{"post":{"operationId":"analytics_fountain_option_bank_append_option","summary":"Append to Option Bank","description":"PUT /v2/option_banks/{id}/append","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","options"],"properties":{"id":{"type":"string"},"options":{"type":"object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/positions-list-all":{"get":{"operationId":"analytics_fountain_positions_list_all","summary":"List Positions","description":"GET /v2/positions","tags":["analytics"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/positions-create-new-position":{"post":{"operationId":"analytics_fountain_positions_create_new_position","summary":"Create a new Position","description":"POST /v2/positions","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/positions-get-by-id":{"get":{"operationId":"analytics_fountain_positions_get_by_id","summary":"Retrieve Position","description":"GET /v2/positions/{id}","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"description":"The Position ID","schema":{"type":"string","description":"The Position ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/positions-update-existing-position":{"post":{"operationId":"analytics_fountain_positions_update_existing_position","summary":"Update Position","description":"PUT /v2/positions/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The Position ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/positions-delete-position":{"post":{"operationId":"analytics_fountain_positions_delete_position","summary":"Delete a Position","description":"DELETE /v2/positions/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Position ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/calendar-slots-list-booked":{"get":{"operationId":"analytics_fountain_calendar_slots_list_booked","summary":"List calendar slots","description":"GET /v2/sessions","tags":["analytics"],"parameters":[{"name":"funnel_id","in":"query","required":false,"description":"Identifier of opening to filter calendar slots on","schema":{"type":"string","description":"Identifier of opening to filter calendar slots on"}},{"name":"with_unbooked","in":"query","required":false,"description":"Indicates whether to include available slots in response","schema":{"type":"boolean","description":"Indicates whether to include available slots in response"}},{"name":"stage_id","in":"query","required":false,"description":"Identifier of stage to filter slots on","schema":{"type":"string","description":"Identifier of stage to filter slots on"}},{"name":"cursor","in":"query","required":false,"description":"Cursor for the next page to view","schema":{"type":"string","description":"Cursor for the next page to view"}},{"name":"time","in":"query","required":false,"description":"Filter by date, options are past, upcoming, a specific date with date=, or a date range with range=","schema":{"type":"string","description":"Filter by date, options are past, upcoming, a specific date with date=, or a date range with range="}},{"name":"page","in":"query","required":false,"description":"The page results to retrieve. The endpoint returns 10 results per page. Use the cursor option to view very old results.","schema":{"type":"boolean","description":"The page results to retrieve. The endpoint returns 10 results per page. Use the cursor option to view very old results."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/shifts-list-shifts":{"get":{"operationId":"analytics_fountain_shifts_list_shifts","summary":"List shifts","description":"GET /v2/shifts","tags":["analytics"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page of results to retrieve.","schema":{"type":"integer","description":"The page of results to retrieve."}},{"name":"per_page","in":"query","required":false,"description":"The number of results to retrieve per page. The endpoint returns 20 results per page by default.","schema":{"type":"integer","description":"The number of results to retrieve per page. The endpoint returns 20 results per page by default."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/calendar-slots-get-available-slots":{"get":{"operationId":"analytics_fountain_calendar_slots_get_available_slots","summary":"List available slots","description":"GET /v2/stages/{id}/available_slots","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifier of stage to list available slots for","schema":{"type":"string","description":"Identifier of stage to list available slots for"}},{"name":"page","in":"query","required":false,"description":"The page of results to view","schema":{"type":"integer","description":"The page of results to view"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/labels-list-in-stage":{"get":{"operationId":"analytics_fountain_labels_list_in_stage","summary":"List All Labels in Stage","description":"GET /v2/stages/{stage_id}/labels","tags":["analytics"],"parameters":[{"name":"stage_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"funnel_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/openings-and-stages-list-opening-stages":{"get":{"operationId":"analytics_fountain_openings_and_stages_list_opening_stages","summary":"List All Opening Stages","description":"GET /v2/funnels/{funnel_id}/stages","tags":["analytics"],"parameters":[{"name":"funnel_id","in":"query","required":true,"description":"The Opening ID","schema":{"type":"string","description":"The Opening ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/openings-and-stages-get-stage":{"get":{"operationId":"analytics_fountain_openings_and_stages_get_stage","summary":"Retrieve stage","description":"GET /v2/stages/{id}","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"description":"The Stage ID","schema":{"type":"string","description":"The Stage ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/export-management-list-timestamped-export-templates":{"get":{"operationId":"analytics_fountain_export_management_list_timestamped_export_templates","summary":"List All Timestamped Export Templates","description":"GET /v2/timestamped_exports/templates","tags":["analytics"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/export-management-download-timestamped-export":{"get":{"operationId":"analytics_fountain_export_management_download_timestamped_export","summary":"Download Timestamped Export","description":"GET /v2/timestamped_exports/{id}","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/export-management-list-all-timestamped-exports":{"get":{"operationId":"analytics_fountain_export_management_list_all_timestamped_exports","summary":"List all Timestamped Exports","description":"GET /v2/timestamped_exports","tags":["analytics"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/export-management-create-timestamped-exports":{"post":{"operationId":"analytics_fountain_export_management_create_timestamped_exports","summary":"Create Timestamped Exports","description":"POST /v2/timestamped_exports","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["template_id"],"properties":{"template_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/users-get-activities":{"get":{"operationId":"analytics_fountain_users_get_activities","summary":"Get User Activities","description":"GET /v2/user_activities/{id}","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"description":"The User ID","schema":{"type":"string","description":"The User ID"}},{"name":"start_time","in":"query","required":true,"description":"Start must be within 30 days of End Time","schema":{"type":"string","description":"Start must be within 30 days of End Time"},"example":"2024-01-01T12:00:00-05:00"},{"name":"end_time","in":"query","required":true,"description":"The end date of the activities","schema":{"type":"string","description":"The end date of the activities"}},{"name":"activity_type","in":"query","required":false,"description":"The key describing the activity","schema":{"type":"string","description":"The key describing the activity"},"example":"stage.transitioned"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/users-list-accessed-all":{"get":{"operationId":"analytics_fountain_users_list_accessed_all","summary":"Get Users","description":"GET /v2/users","tags":["analytics"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/posthire-worker-management-list-workers":{"get":{"operationId":"analytics_fountain_posthire_worker_management_list_workers","summary":"Get Workers","description":"GET /v2/workers","tags":["analytics"],"parameters":[{"name":"funnel_id","in":"query","required":false,"description":"The opening ID","schema":{"type":"string","description":"The opening ID"}},{"name":"is_active","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"page","in":"query","required":false,"description":"Optional integer to indicate the page of pagination","schema":{"type":"integer","description":"Optional integer to indicate the page of pagination"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/posthire-worker-management-get-worker-data":{"get":{"operationId":"analytics_fountain_posthire_worker_management_get_worker_data","summary":"Get A Worker","description":"GET /v2/workers/{id}","tags":["analytics"],"parameters":[{"name":"id","in":"query","required":true,"description":"The Worker ID","schema":{"type":"string","description":"The Worker ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/posthire-worker-management-update-worker":{"post":{"operationId":"analytics_fountain_posthire_worker_management_update_worker","summary":"Update A Worker","description":"PATCH /v2/workers/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Worker ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/posthire-worker-management-activate-worker":{"post":{"operationId":"analytics_fountain_posthire_worker_management_activate_worker","summary":"Activate A Worker","description":"POST /v2/workers/{id}/activate","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Worker ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/posthire-worker-management-deactivate-worker":{"post":{"operationId":"analytics_fountain_posthire_worker_management_deactivate_worker","summary":"Deactivate A Worker","description":"POST /v2/workers/{id}/deactivate","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Worker ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/workflows-get-all-workflows":{"get":{"operationId":"analytics_fountain_workflows_get_all_workflows","summary":"List all Workflows","description":"GET /api/v2/workflows","tags":["analytics"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/workflows-delete-workflow":{"post":{"operationId":"analytics_fountain_workflows_delete_workflow","summary":"Delete a Workflow","description":"DELETE /api/v2/workflows/{id}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:fountain/option-bank-list-all-banks":{"get":{"operationId":"analytics_fountain_option_bank_list_all_banks","summary":"List All Option Banks","description":"GET /v2/option_banks","tags":["analytics"],"parameters":[{"name":"page","in":"query","required":false,"description":"Optional integer to indicate the page of pagination","schema":{"type":"string","description":"Optional integer to indicate the page of pagination"}},{"name":"per_page","in":"query","required":false,"description":"Optional integer to define page size for pagination","schema":{"type":"string","description":"Optional integer to define page size for pagination"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:fountain/option-bank-create-applicant-notes":{"post":{"operationId":"analytics_fountain_option_bank_create_applicant_notes","summary":"Create Option Bank","description":"POST /v2/option_banks","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}