Function reference • QualtricsInR

Admin Level Functions All administration level functions require you are recognized as a brand adminstrator for your account/organisation.
`get_organization_information()`	Retrieve general information about an organization
`create_division()`	Create a new division
`get_division()`	Returns general information about a division
`update_division()`	Update a division's settings
`list_groups()`	List all existing groups for the organization
`create_group()`	Create a new group
`get_group()`	Retrieve group information
`update_group()`	Update group's definition parameters
`delete_group()`	Delete a group
`add_user_group()`	Add a new user to a given group
`remove_user_group()`	Remove a user from a given group
`list_users()`	Retrieve the list of all user accounts for the brand
`get_user()`	Retrieve a user account's information
`create_user()`	Create a new user account
`update_user()`	Update a user's account parameters
`delete_user()`	Delete a user account
`get_user_api_token()`	Returns the active api token for an account
`create_user_api_token()`	Create an api token for a user account
`who_am_i()`	Determine the user ID and other user information associated with an Qualtrics API token or a Qualtrics OAuth access token.
`create_erasure_request()`	Create an erasing request
`list_erasure_requests()`	List all erasure request for a brand
`get_erasure_request()`	Retrieve a given erasure request
`list_event_types()`	Retrieve the type of activity events
`get_logins_events()`	Retrieve the collection of logins events
`get_session_creations_events()`	Retrieve the collection of logins events
`get_session_terminations_events()`	Retrieve the collection of session_terminations events
`get_password_resets_events()`	Retrieve the collection of password_resets events
General Survey Administration Function to manipulate surveys within and accross accounts
`list_surveys()`	Retrieve the list of surveys for a given user account
`copy_survey()`	Create a copy of a survey
`import_survey()`	Import a survey into Qualtrics
`import_survey_fromurl()`	Import a survey into Qualtrics based on a file URL
`share_survey()`	Share a survey with another account
`update_survey()`	Update a surve's name, status or expiration date
`get_survey_quota()`	get_survey_quota retrieves the survey quota information
`insert_embedded_data()`	Insert embedded data fields into a survey
`get_survey_response_counts()`	Retrieve a survey's response counts by response type
Survey Responses Function to interact with survey responses.
`get_survey_responses()`	Export a survey's responses into R
`request_downloads()` `download_requested()` `check_status()`	Request downloads
`update_response()`	Update the value of an embedded data field in a survey response
`delete_response()`	Delete a survey response
`start_response_import()`	start_response_import imports a survey based on a loacl survey file
`start_response_import_url()`	start_response_import_url imports a survey based on a loacl survey file
`get_response_import_progress()`	start_response_import_url imports a survey based on a loacl survey file
Survey Distribution Functions for manipulating survey distribution information
`create_email_distribution()`	Create an email distribution or generate distribution links
`create_reminder_distribution()`	Create a reminder distribution for an existing email distribution
`create_thankyou_distribution()`	Create a thank you distribution for an exisiting email distribution
`list_distributions()`	List all distributions associated to a survey
`get_distribution()`	Retrieve a given survey distribution object
`generate_distribution_links()`	Generate survey distribution links
`list_distribution_links()`	List the survey links associated with a distribution
`send_email_mailinglist()`	Send Email to Mailing List
`delete_distribution()`	Delete a survey distribution
`create_sms_distribution()`	Create a new survey distribution via SMS
`get_sms_distribution()`	Retrieve an sms survey distribution object
`delete_sms_distribution()`	Delete an sms survey distribution
`list_sms_distributions()`	List all sms distributions associated to a survey
Survey Object Manipulation Function to interact with survey objects.
`get_survey_flow()`	Retrieve the flow structure of a survey
`update_survey_flow()`	Update the survey flow
`update_flow_element()`	Update a specific survey flow element
`get_block()`	Retrieve a survey block
`update_block()`	Update a block
`delete_block()`	Delete a block
`create_block()`	Create a new block
`list_blocks()`	List all block ids
`generate_block_id()`	Generate a compatible block id
`update_survey_options()`	Update Survey Options
`get_survey()`	Retrieve a survey
`get_survey_meta_data()`	Retrieve survey meta data
`delete_survey()`	Delete a survey
`create_survey()`	Create a survey
`get_survey_languages()`	Retrieve the list of languages in which a survey is available
`get_survey_translations()`	get_survey_translations retrieves the full translation
`update_survey_languages()`	Update the list of available survey languages for a survey
`update_survey_translations()`	Update survey translation
`get_survey_options()`	Retrieve Survey Options
`list_questions()`	List all survey questions
`get_survey_question()`	Retrieve a survey question
`delete_survey_question()`	Delete a survey question
`get_questions_mapping()`	Get survey question mapping
Contacts Function to interact with contacts in the mailing library
`list_mailinglists()`	Retrieve all mailing lists from account
`get_mailinglist()`	Retrieve a specific mailing list
`create_mailinglist()`	Create a new mailing list
`update_mailinglist()`	Update an existing mailing list
`delete_mailinglist()`	Delete an existing mailing list
`list_contacts()`	Retrieve all contacts in a mailing list
`get_contact()`	Retrieve a the information related to a certain contact
`create_contact()`	Create a new contact in a mailing list
`update_contact()`	Updates a contact's information in a mailing list
`delete_contact()`	Delete a contact from a mailing list
`list_samples()`	List samples associated with a mailing list
`get_sample()`	Retrieve a sample from a mailing list
Directories The Directories endpoint allows you to retrieve a list of Directories within your Brand.
`list_directory_contacts()`	List Directories for a Brand
Library Manipulation of graphic and message library contents
`list_libraries()`	List all available libraries in the account
`list_library_blocks()`	Lists the library blocks for the caller of this API.
`list_library_questions()`	Lists the library questions for the caller of this API.
`list_library_surveys()`	Lists the library surveys for the caller of this API.
`list_messages()`	List all messages from a given library
`get_message()`	Retrieve a message from the library
`create_message()`	Create a new message in the library
`update_message()`	Update an existing library message
`delete_message()`	Delete a library message
`upload_graphic()`	upload_graphic imports a survey based on a loacl survey file
`upload_graphic_fromurl()`	upload_graphic_fromurl imports a survey based on a loacl survey file
`delete_graphic()`	delete_graphic retrieves a full survey object

Reference

Admin Level Functions

General Survey Administration

Survey Responses

Survey Distribution

Survey Object Manipulation

Contacts

Directories

Library