Public Fountain API Reference

The public API procedures may call the internal procedures which should not be used directly as they can be changed without any explicit notification in the newer versions of the connector. Internal procedures can be recognized by the prefix internal_ in their names. Public API procedures do not have such prefix in their names.

Applicant Management

Applicants

Applicants
Parameter
<id> (optional): Returns information about the specified applicant
<funnel_id> (optional): Filter by Opening ID
<stage_id> (optional): Filter by Stage ID
<stage> (optional): Filter by Stage type
<labels> (optional): Filter by label (must be URL-encoded)
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
email	string
name	string
first_name	string
last_name	string
phone_number	string
data_city	string
data_employee_id	string
data_nationality	string
data_about_me	string
data_employment_status	string
data_signed_up_timestamp	timestamp
created_at	timestamp
receive_automated_emails	boolean
last_transitioned_at	timestamp
id	string
funnel_title	string
funnel_custom_id	string
funnel_id	string
stage_title	string
stage_id	string
stage_form_description	string
stage_form_title	string

Example

SQL

CREATE VIEW fountain_examples.example_Applicants AS
	SELECT * FROM (
		CALL fountain.Applicants (
			preview => TRUE
		)
	)x

ApplicantDocuments

Accessing documents from Fountain
Parameter
<applicant_id> (required): Applicant's UUID
<target_table> (optional): Table name to save the data to
<sourceColumns> (optional): The list of source columns, calculated by the caller
<targetColumns> (optional): The list of target columns, calculated by the caller
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
applicant_id	string
id	string
name	string
friendly_name	string
filename	string
public_url	string
size	string
stage_id	string
stage_title	string

Example

SQL

CREATE VIEW fountain_examples.example_ApplicantDocuments AS
	SELECT * FROM (
		CALL fountain.ApplicantDocuments (
			applicant_id => '7bb55fe2-556f-437d-9ba9-7cf4c639b93a',
			preview => TRUE
		)
	)x

InterviewSessions

Interview Sessions
Parameter
<applicant_id> (required): Applicant's UUID
<target_table> (optional): Table name to save the data to
<sourceColumns> (optional): The list of source columns, calculated by the caller
<targetColumns> (optional): The list of target columns, calculated by the caller
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
applicant_id	string
start_time	string
end_time	string
location	string
recruiter	string
instructions	string
showed_up	boolean
id	string

Example

SQL

CREATE VIEW fountain_examples.example_InterviewSessions AS
	SELECT * FROM (
		CALL fountain.InterviewSessions (
			applicant_id => '7bb55fe2-556f-437d-9ba9-7cf4c639b93a',
			preview => TRUE
		)
	)x

TransitionHistory

Accessing documents from Fountain
Parameter
<applicant_id> (required): Applicant's UUID
<target_table> (optional): Table name to save the data to
<sourceColumns> (optional): The list of source columns, calculated by the caller
<targetColumns> (optional): The list of target columns, calculated by the caller
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
applicant_id	string
stage_id	string
stage_title	string
created_at	timestamp

Example

SQL

CREATE VIEW fountain_examples.example_TransitionHistory AS
	SELECT * FROM (
		CALL fountain.TransitionHistory (
			applicant_id => '7bb55fe2-556f-437d-9ba9-7cf4c639b93a',
			preview => TRUE
		)
	)x

Label Management

Labels

All labels for an applicant
Parameter
<applicant_id> (required): Applicant's UUID
<target_table> (optional): Table name to save the data to
<sourceColumns> (optional): The list of source columns, calculated by the caller
<targetColumns> (optional): The list of target columns, calculated by the caller
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
applicant_id	string
title	string
completed	boolean

Example

SQL

CREATE VIEW fountain_examples.example_Labels AS
	SELECT * FROM (
		CALL fountain.Labels (
			applicant_id => '7bb55fe2-556f-437d-9ba9-7cf4c639b93a',
			preview => TRUE
		)
	)x

LabelsPerStage

LabelsPerStage that are available in a specific stage
Parameter
<stage_id> (required): Stage of the workflow you wish to list labels for
<target_table> (optional): Table name to save the data to
<sourceColumns> (optional): The list of source columns, calculated by the caller
<targetColumns> (optional): The list of target columns, calculated by the caller
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
stage_id	string
title	string
completed	integer

Example

SQL

CREATE VIEW fountain_examples.example_LabelsPerStage AS
	SELECT * FROM (
		CALL fountain.LabelsPerStage (
			stage_id => '8f59494e-407a-4de3-bb51-68edd86bff69',
			preview => TRUE
		)
	)x

Notes Management

Notes

All Notes for an applicant
Parameter
<applicant_id> (required): Applicant's UUID
<target_table> (optional): Table name to save the data to
<sourceColumns> (optional): The list of source columns, calculated by the caller
<targetColumns> (optional): The list of target columns, calculated by the caller
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
applicant_id	string
id	string
content	string
created_at	timestamp
updated_at	timestamp
user_name	string
user_email	string
user_id	string

Example

SQL

CREATE VIEW fountain_examples.example_Notes AS
	SELECT * FROM (
		CALL fountain.Notes (
			applicant_id => '7bb55fe2-556f-437d-9ba9-7cf4c639b93a',
			preview => TRUE
		)
	)x

Sessions and Slot Management

AvailableSlots

All the available slots
Parameter
<stage_id> (required): Stage of the workflow you wish to list labels for
<target_table> (optional): Table name to save the data to
<sourceColumns> (optional): The list of source columns, calculated by the caller
<targetColumns> (optional): The list of target columns, calculated by the caller
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
stage_id	string
id	string
location	string
start_time	string
end_time	string
recruiter	string
max_attendees	integer
booked_slots_count	integer

Example

SQL

CREATE VIEW fountain_examples.example_AvailableSlots AS
	SELECT * FROM (
		CALL fountain.AvailableSlots (
			stage_id => '8f59494e-407a-4de3-bb51-68edd86bff69',
			preview => TRUE
		)
	)x

Positions and Stages

Openings

Openings within your account
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
id	string
custom_id	string
title	string
address	string
time_zone	string
description	string
requirements	string
is_private	boolean
active	boolean
location_id	string
location_name	string

Example

SQL

CREATE VIEW fountain_examples.example_Openings AS
	SELECT * FROM (
		CALL fountain.Openings (
			preview => TRUE
		)
	)x

Stages

All stages in the position (also known as funnels)
Parameter
<funnel_id> (required): Funnel ID
<target_table> (optional): Table name to save the data to
<sourceColumns> (optional): The list of source columns, calculated by the caller
<targetColumns> (optional): The list of target columns, calculated by the caller
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
funnel_id	string
id	string
custom_id	string
title	string
type	string

Example

SQL

CREATE VIEW fountain_examples.example_Stages AS
	SELECT * FROM (
		CALL fountain.Stages (
			funnel_id => '3083baf8-1577-4cec-b93c-561b515135f4',
			preview => TRUE
		)
	)x

Export Management

ExportTemplates

Timestamped export templates in the account
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
id	string
to_param	string
title	string
lower_bound	timestamp
upper_bound	timestamp
data_keys	string
busy	boolean
type	string
number_of_days	integer
funnel_ids	string

Example

SQL

CREATE VIEW fountain_examples.example_ExportTemplates AS
	SELECT * FROM (
		CALL fountain.ExportTemplates (
			preview => TRUE
		)
	)x

Worker Management

Workers

Workers within your account
Parameter
<id> (optional): Return single item, rather than list
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
is_active	boolean
name	string
email	string
id	string
approved_at	timestamp

Example

SQL

CREATE VIEW fountain_examples.example_Workers AS
	SELECT * FROM (
		CALL fountain.Workers (
			preview => TRUE
		)
	)x

Loop Addons on top of API procedures

Download_ApplicantDocuments

Accessing documents from Fountain
Parameter
<applicants_table> (required): Table containing the list of applicants
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
applicant_id	string
id	string
name	string
friendly_name	string
filename	string
public_url	string
size	string
stage_id	string
stage_title	string

Example

SQL

CREATE VIEW fountain_examples.example_Download_ApplicantDocuments AS
	SELECT * FROM (
		CALL fountain.Download_ApplicantDocuments (
			applicants_table => 'dwh.Fountain_Applicants',
			preview => TRUE
		)
	)x

Download_InterviewSessions

Interview Sessions for all Applicants
Parameter
<applicants_table> (required): Table containing the list of applicants
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
applicant_id	string
start_time	string
end_time	string
location	string
recruiter	string
instructions	string
showed_up	boolean
id	string

Example

SQL

CREATE VIEW fountain_examples.example_Download_InterviewSessions AS
	SELECT * FROM (
		CALL fountain.Download_InterviewSessions (
			applicants_table => 'dwh.Fountain_Applicants',
			preview => TRUE
		)
	)x

Download_TransitionHistory

Transition history
Parameter
<applicants_table> (required): Table containing the list of applicants
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
applicant_id	string
stage_id	string
stage_title	string
created_at	timestamp

Example

SQL

CREATE VIEW fountain_examples.example_Download_TransitionHistory AS
	SELECT * FROM (
		CALL fountain.Download_TransitionHistory (
			applicants_table => 'dwh.Fountain_Applicants',
			preview => TRUE
		)
	)x

Download_Labels

Labels for All Applicants
Parameter
<applicants_table> (required): Table containing the list of applicants
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
applicant_id	string
title	string
completed	boolean

Example

SQL

CREATE VIEW fountain_examples.example_Download_Labels AS
	SELECT * FROM (
		CALL fountain.Download_Labels (
			applicants_table => 'dwh.Fountain_Applicants',
			preview => TRUE
		)
	)x

Download_LabelsPerStage

Labels for all stages
Parameter
<stages_table> (required): Table containing the list of stages
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
stage_id	string
title	string
completed	integer

Example

SQL

CREATE VIEW fountain_examples.example_Download_LabelsPerStage AS
	SELECT * FROM (
		CALL fountain.Download_LabelsPerStage (
			stages_table => 'dwh.Fountain_Stages',
			preview => TRUE
		)
	)x

Download_Notes

Notes for All Applicants
Parameter
<applicants_table> (required): Table containing the list of applicants
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
applicant_id	string
id	string
content	string
created_at	timestamp
updated_at	timestamp
user_name	string
user_email	string
user_id	string

Example

SQL

CREATE VIEW fountain_examples.example_Download_Notes AS
	SELECT * FROM (
		CALL fountain.Download_Notes (
			applicants_table => 'dwh.Fountain_Applicants',
			preview => TRUE
		)
	)x

Download_AvailableSlots

Available slots for all stages
Parameter
<stages_table> (required): Table containing the list of stages
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
stage_id	string
id	string
location	string
start_time	string
end_time	string
recruiter	string
max_attendees	integer
booked_slots_count	integer

Example

SQL

CREATE VIEW fountain_examples.example_Download_AvailableSlots AS
	SELECT * FROM (
		CALL fountain.Download_AvailableSlots (
			stages_table => 'dwh.Fountain_Stages',
			preview => TRUE
		)
	)x

Download_Stages

Stages for all funnels
Parameter
<funnels_table> (required): Table containing the list of funnels
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
funnel_id	string
id	string
custom_id	string
title	string
type	string

Example

SQL

CREATE VIEW fountain_examples.example_Download_Stages AS
	SELECT * FROM (
		CALL fountain.Download_Stages (
			funnels_table => 'dwh.Funnels',
			preview => TRUE
		)
	)x