• Suran API v2
• v1 / v2

Resources

Account schedules

Resource	Description
GET /api/v2/individuals/:individual_id/account_schedules	View all recurring gifts for an individual
GET /api/v2/individual/:individual_id/account_schedule/:gift_id	View a specific recurring gift for an individual
POST /api/v2/individuals/:individual_id/account_schedules	Create a recurring gift
POST /api/v2/individuals/:individual_id/single_gift	Create a single gift
GET /api/v2/individuals/:individual_id/resend_gift_emails	Resend gift emails
DELETE /api/v2/individuals/:individual_id/account_schedules/:id	Cancel a recurring gift
POST /api/v2/individuals/:individual_id/edit_recurring_gift/:id	Edit a recurring gift
POST /api/v2/individuals/:individual_id/enable_recurring_fee_assist	Enables fee assist for all eligible recurring gifts

Accounts

Resource	Description
GET /api/v2/individuals/:individual_id/accounts	List of accounts for an individual
GET /api/v2/individuals/:individual_id/account/:account_guid	Get specific account for individual
POST /api/v2/individuals/:individual_id/accounts	Create an account with SST
POST /api/v2/individuals/:individual_id/update_cc_account	Update a credit card account with SST
POST /api/v2/individuals/:individual_id/update_ach_account	Update a bank account with SST
PUT /api/v2/individuals/:individual_id/accounts/:id	Update an account to be preferred
DELETE /api/v2/individuals/:individual_id/accounts	Delete an account with SST

Accounts public

Resource	Description
POST /api/v2/public/individuals/:individual_id/accounts	Create an account with SST

Address

Resource	Description
PUT /api/v2/individuals/:individual_id/address/:id	Update an individual address
GET /api/v2/individuals/:individual_id/address/:id	Show an individual address
PUT /api/v2/individuals/:individual_id/church/:id	Update an individual church

Attendance groups

Resource	Description
GET /api/v2/attendance_groups	List of all groups based on provision
GET /api/v2/attendance_groups/:id	Display a specific group

Attendances

Resource	Description
GET /api/v2/attendance_groups/:attendance_group_id/attendances	All attendances for a given date
POST /api/v2/attendance_groups/:attendance_group_id/attendances	Create an attendance for a group
DELETE /api/v2/attendance_groups/:attendance_group_id/attendances	Delete an attendance for a group

Authenticated

Resource	Description
POST /api/v2/authenticated_test	Login

Authenticated provisions

Resource	Description
GET /api/v2/provisions	List of Provisions
PUT /api/v2/provisions/:id

Background check

Resource	Description
GET /api/v2/background_check_expiring_soon/:background_check_id	Send background check expiring email to individual
GET /api/v2/background_check_expired/:background_check_id	Send background check expired email to individual

Church positions

Resource	Description
GET /api/v2ucc/get_church_profiles
POST /api/v2ucc/submit_church_profile

Churches

Resource	Description
GET /api/v2/churches	List of churches
GET /api/v2/churches/:id	Show a church
GET /api/v2/churches/:church_id/coordinates	Coordinates for church address
GET /api/v2/churches/:church_id/contact_information
POST /api/v2/churches/mass_emails	Queue emails for all selected churches
POST /api/v2/churches/mass_emails_with_option	Queue emails for all selected churches with option
GET /api/v2/churches/emails	List of emails for churches
GET /api/v2/church/:id/picture/:hash	Church picture

Churches public

Resource	Description
GET /api/v2/churches/names	List of church names

Check in Check out

Resource	Description
GET /api/v2/cicos	List of all Check in Check out data
POST /api/v2/cicos	Create a check in calling database function checkinindividual()
PUT /api/v2/cicos/:id	Mark a check in as checked out using database function checkoutindividual()
GET /api/v2/cicos/:id	Show an single Check in Check out
GET /api/v2/cicos/:id/individual	Show valid individual for Checkout from a Given Checkin ID
GET /api/v2/cicos/:id/checkout_individuals	Show individuals valid to checkout someone for a Given ID
GET /api/v2/cicos/event_sets	Show Check in Check out Event Sets for my Provision
GET /api/v2/cicos/events/:id	Show Check in Check out Events for a Set
GET /api/v2/cicos/events/:id/preferred	Show Check in Check out preferred group for individual
GET /api/v2/cicos/groups	Show Check in Check out Groups from a Group/Group Set
GET /api/v2/cicos/family_search	Show available family members from a name search.
GET /api/v2/cicos/individuals	Show individuals for cico.
GET /api/v2/cicos/scan	Show available family members from a scan.
GET /api/v2/cicos/visitors	Show available visitors from a search.
GET /api/v2/cicos/individual/:individual_id	Show Groups that a individual is currently checked into.
GET /api/v2/cicos/individual/:individual_id/info	Shows information for checked-in individual

Circulation status

Resource	Description
GET /api/v2/circulation_status_notification	Send notification of circulation status change

Contacts

Resource	Description
GET /api/v2/individuals/:individual_id/contacts	List all contact numbers for an individual
POST /api/v2/individuals/:individual_id/contacts	Add a new contact
PUT /api/v2/individuals/:individual_id/contacts/:id	Edit a contact
PUT /api/v2/individuals/unlisted/:id	Edit unlisted of a contact
PUT /api/v2/contacts/set_primary_email	Set Primary Email for an Individual
GET /api/v2/contacts/validate_email	Validate an email address
DELETE /api/v2/individuals/:individual_id/contacts/:id	Delete a contact

Customers

Resource	Description
GET /api/v2/individuals/:individual_id/customers	List of customers for individual
GET /api/v2/customers/:individual_id/:customer_id	Get a specific customer
GET /api/v2user/customers/:individual_id	Get customers from SUF user contact
GET /api/v2/billing/surcharges	Surcharges for Engage Billing
GET /api/v2/billing/invoices	Billing Invoice Information
GET /api/v2/billing/user/invoices	Billing Invoices for user contact
GET /api/v2/customer/invoices	Billing Invoices for a specific customer
GET /api/v2/billing/invoice_details	Billing Invoice Details
GET /api/v2/billing/settings	Get current billing settings
POST /api/v2/billing/update_settings	Update billing settings

Databases

Resource	Description
GET /api/v2/databases	Fetch all databases associated with current user
DELETE /api/v2/databases/:database	Database delete
POST /api/v2/databases/:program_shortname	Database create
PUT /api/v2/databases/:database	Update database information for a database
GET /api/v2/databases/:database	Fetch database information

Doc

Resource	Description
GET /api/v2/doc/ministers	List of DOC ministers that have standing

Engage forms

Resource	Description
GET /api/v2/individuals/:individual_id/engage_forms	List of forms, published to Engage, for an individual

Engage settings

Resource	Description
GET /api/v2/engage_settings	Retrieve Engage settings
PUT /api/v2/engage_settings/giving_sets/:id
PUT /api/v2/engage_settings/giving_set_order/:id
POST /api/v2/engage_settings/giving_sets
DELETE /api/v2/engage_settings/giving_sets/:id
PUT /api/v2/engage_settings	Update Engage settings
POST /api/v2/sms_giving_number	Update text giving number

Engage user

Resource	Description
PUT /api/v2/individuals/:individual_id/fee_assist_preference	Update fee_assist_preference for individual

Event registrations

Resource	Description
GET /api/v2/event_registrations	List of Event Registration Tools, published to Engage

Expiring credit card

Resource	Description
GET /api/v2/expiring_credit_cards	Get a list of expiring credit cards for this database

Expiring credit card notice

Resource	Description
GET /api/v2/send_expiring_credit_card_notices	Sends expiring credit card notices

Geographic availability

Resource	Description
GET /api/v2ucc/get_geographic_availability
POST /api/v2ucc/update_geographic_availability	Update a minister snapshot geographic availability

Giving detail

Resource	Description
GET /api/v2/search_transactions	Search transactions for database
GET /api/v2/transaction_detail/:transaction_guid	Return details about transaction
GET /api/v2/refund/:transaction_guid	Refund a transaction
GET /api/v2/giving_history/:individual_id	List all Giving History for an individual
GET /api/v2/giving_detail/:contreference	List of all giving records with that contreference

Giving sets

Resource	Description
GET /api/v2/giving_sets	Show all Giving Sets
GET /api/v2/giving_sets/:id	Show a specific Giving Set

Giving units

Resource	Description
GET /api/v2/giving_unit	Show Giving Unit for logged-in individual
PUT /api/v2/giving_unit	Update giving unit email

Individual groups

Resource	Description
GET /api/v2/individual_groups	Displays individual groups
GET /api/v2/individual_subscribable_groups	Displays groups that users can subscribe or unsubscribe
GET /api/v2/individual_groups/:id	Shows an individual group
POST /api/v2/individual_groups/:id/mass_email	Queue mass email for individual group
GET /api/v2/individual_groups/:id/emails	List of emails for individual group
GET /api/v2/individual_groups/:id/phones	List of phone numbers for individual group

Individuals

Resource	Description
GET /api/v2/individuals	List of individuals
GET /api/v2/individuals/:id/groups	List of the groups of the individual
PUT /api/v2/individuals/:id	Update an individual
PUT /api/v2/individuals/verify_sms_giving/:id	Send text message to entered phone number
PUT /api/v2/individuals/clear_picture/:id	Clear an individuals picture
POST /api/v2/individuals/add_groups	Add individual groups
DELETE /api/v2/individuals/delete_groups	Delete individual groups
GET /api/v2/individual_groups/:individual_group_id/individuals/:id	Individual in a given Individual Group
GET /api/v2/individual_groups/:individual_group_id/individuals	Individuals in a given Individual Group
GET /api/v2/all_individuals_from_groups	Individuals in all groups available to user
GET /api/v2/individuals/:id	Show an individual
GET /api/v2/churches/:church_id/individuals	Individuals in a given Church
POST /api/v2/individuals/mass_emails	Queue mass email for individuals
POST /api/v2/individuals/mass_emails_with_option	Queue mass email for individuals with option
GET /api/v2/individuals/church_positions/:individual_id	Get individuals church position
GET /api/v2/individuals/:id/picture/:hash	Individuals in a given Church
POST /api/v2/update_name/:id	Update an individuals name information
GET /api/v2Get list of titles
POST /api/v2/update_birthdate/:id	Update individuals birthdate info

Individuals public

Resource	Description
DELETE /api/v2/individuals/remove_giving	Remove Phone Number giving link

Login

Resource	Description
POST /api/v2/login	Login
POST /api/v2/engage_login	Login

Login recovery

Resource	Description
GET /api/v2/login_recovery	List of individuals for given email address
GET /api/v2/login_recovery/by_reset_code	Finds individual by password reset code
PUT /api/v2/login_recovery/update_password	Method to change password
PUT /api/v2/login_recovery/update_username	Method to update username
PUT /api/v2/login_recovery/reset	Reset an individual password
POST /api/v2/login_recovery	Create an individual setup to be able to do Online Giving

Logo

Resource	Description
GET /api/v2/logo	Retrieves the logo from the database
POST /api/v2/:provision/logo/save_to_cdn	Retrieves the logo from the database and saves it to the cdn.suran.com filesystem
POST /api/v2/:provision/logo/delete_from_cdn	Deletes the logo from the cdn.suran.com filesystem

Mass email

Resource	Description
POST /api/v2/mass_email	Queue mass email for contact numbers
POST /api/v2/mass_email_with_option	Queue mass email with the option to send to sender
PUT /api/v2/mass_email/:id	Send mass email

Master codes

Resource	Description
GET /api/v2/master_codes/visitation_types	List of Visitation Types
GET /api/v2/master_codes/staff_codes	List of Staff Codes
GET /api/v2/master_codes/phone_types	List of Phone Types
GET /api/v2/master_codes/email_types	List of Email Types
GET /api/v2/master_codes/contact_types	List of Contact Types

Minister profile

Resource	Description
GET /api/v2ucc/minister_profile/background_check	Get background check status for minister profile
POST /api/v2ucc/minister_profile/background_check	Set status of background check for minister profile
GET /api/v2ucc/minister_profile/find_reference	Get all available references for a giving email
GET /api/v2ucc/minister_profile/contacted_references	Get all contacted references
GET /api/v2ucc/minister_profile/contacted_references/:id	Get details for contacted reference
POST /api/v2ucc/minister_profile/contact_reference	Contact a reference
POST /api/v2ucc/minister_profile/resend_reference_email/:reference_id	Resend request email to a reference
DELETE /api/v2ucc/minister_profile/contacted_references/:id	Remove a specific reference
GET /api/v2ucc/minister_profile/start_search_and_call
GET /api/v2/ucc/minister_profile/withdraw_from_search_and_call
GET /api/v2ucc/get_minister_profile
POST /api/v2ucc/update_minister_profile
POST /api/v2ucc/set_viewed
POST /api/v2/ucc/save_disclosure
POST /api/v2/ucc/save_education
POST /api/v2/ucc/save_optional_web_presence
POST /api/v2/ucc/save_ecclesiastical
POST /api/v2/ucc/save_vocational
GET /api/v2/ucc/get_errors
POST /api/v2/ucc/submit_minister_profile

Minister snapshot

Resource	Description
GET /api/v2ucc/minister_snapshot/:minister_id	Get minister snapshot for a specific minister
GET /api/v2ucc/visible_minister_snapshots	Get all visible minister snapshots

Ministry position

Resource	Description
GET /api/v2ucc/get_churches	Get all churches in current conferences
GET /api/v2ucc/get_ministry_positions	Get all ministry position in current conferences
GET /api/v2ucc/get_ministry_position/:id	Get a specific ministry position
POST /api/v2ucc/update_ministry_position	Create a ministry position
UPDATE /api/v2ucc/update_ministry_position_status
DELETE /api/v2ucc/delete_ministry_position

Ministry position committee members

Resource	Description
GET /api/v2ucc/get_ministry_position_committee_members	Get committee members for a specific ministry position
POST /api/v2ucc/set_committee_chair	Clear old committe chair and set new one
GET /api/v2ucc/find_committee_member	Get all available committee members for an email
POST /api/v2/ucc/add_ministry_position_committee_member	Add a ministry position committee member
POST /api/v2ucc/minister_profile/resend_member_email/:member_id	Resend request email to a committee member
DELETE /api/v2/ucc/delete_ministry_position_committee_member	Delete a ministry position committee member

One time charge

Resource	Description
POST /api/v2/one_time_charge	One Time Charge

Pastorals

Resource	Description
GET /api/v2/individuals/:individual_id/pastorals	List all pastoral records for an individual
POST /api/v2/individuals/:individual_id/pastorals	Create a new Pastoral record for an individual
PUT /api/v2/individuals/:individual_id/pastorals/:id	Edit a pastoral record
DELETE /api/v2/individuals/:individual_id/pastorals/:id	Delete a pastoral record

Payment designations

Resource	Description
GET /api/v2/accounts
GET /api/v2/payment_designations
GET /api/v2/payment_designation_by_slug
POST /api/v2/payment_designations
POST /api/v2/payment_designations/:designation_id
DELETE /api/v2/payment_designations/:designation_id

Payments

Resource	Description
POST /api/v2/individuals/:individual_id/payments	Create payment for customer
GET /api/v2/:individual_id/payments	Return individuals payments
GET /api/v2/:individual_id/user/payments	Return payments for customer connected to user contact
GET /api/v2:individual_id/customer/payments/:customer_id	Return payments for a specific customer

Payroll checks

Resource	Description
GET /api/v2/payroll_checks	Display Payroll Checks for an employee

Payroll deductions

Resource	Description
GET /api/v2/payrolls/:payroll_id/payroll_deductions	Display all Payroll Deductions for a given payroll

Payroll details

Resource	Description
GET /api/v2/payrolls/:payroll_id/payroll_details/:id	Display Payroll Details for a single payroll
GET /api/v2/payrolls/:payroll_id/payroll_details	Display all Payroll Details for a given payroll

Payroll masters

Resource	Description
GET /api/v2/payroll_masters	Display all Payroll Masters

Payroll ytd

Resource	Description
GET /api/v2/payroll_ytd/:year	Display payroll YTD values for an employee for a given year
GET /api/v2/payroll_ytd	Display payroll YTD values for an employee for the current year and previous year
GET /api/v2/payroll_ytd/:year/pay_items	Display payroll YTD values for pay items
GET /api/v2/payroll_ytd/:year/deductions	Display payroll YTD values for deductions

Payrolls

Resource	Description
GET /api/v2/payrolls/:id	Display a single payroll
GET /api/v2/payrolls	Display all payrolls

Pdf

Resource	Description
GET /api/v2/snapshot_pdf	Get a pdf
GET /api/v2/profile_pdf	Get a pdf
GET /api/v2/background_pdf	Get a pdf

Privacy settings

Resource	Description
POST /api/v2/update_privacy_settings	Update users privacy settings

Provisions

Resource	Description
GET /api/v2/provisions/:provision_code	Show an Provisions's information from Provision Code
GET /api/v2/provision	Show an Provisions's information from Provision Code retrieved from Header
GET /api/v2/provisions/:id	Show an Provisions's information from ID
POST /api/v2/provisions/transfer	Transfer a device
GET /api/v2/provisions/reset_email	Sends email and returns email address
GET /api/v2visitations/:id/provisions	All provisions for this visitation

Receipts

Resource	Description
GET /api/v2/vendors	Show all available vendors
GET /api/v2/paymentmethods	Show all available payment methods
GET /api/v2/chart_of_accts	Show all available chart_of_accts
POST /api/v2/default_payment_method
POST /api/v2/receipt	Submit a new receipt

Recent contributions

Resource	Description
GET /api/v2/individuals/:individual_id/recent_contributions
GET /api/v2/individuals/:individual_id/recent_contributions/:id

Recurring email

Resource	Description
GET /api/v2/send_recurring_email/:transaction_guid	Sends recurring giving email

Redis local

Resource	Description
POST /api/v2/redis_local/:provision_code/invalidate	Invalidate redis cache for a provision and, optionally, a slug

Reference

Resource	Description
GET /api/v2ucc/reference/requests	Get all reference requests
GET /api/v2ucc/reference/request/:id	Get a specific reference request
POST /api/v2ucc/reference/request/:id	Update a specific reference request

Registration payments

Resource	Description
POST /api/v2/individuals/:individual_id/registration_payments	Make a registration payment for an individual

Registrations

Resource	Description
GET /api/v2/individuals/:individual_id/registrations	View all registrations for an individual

Reminders

Resource	Description
GET /api/v2/reminders	Displays upcoming events in the next 30 days
GET /api/v2/reminders/overdue	Display overdue visitation reminders

Sessions

Resource	Description
GET /api/v2/sessions	Get logged-in individual
GET /api/v2/refresh_session	Refresh expiring session cookies
GET /api/v2/status	Get expiration status of session cookie
DELETE /api/v2/logout	Logout
GET /api/v2/description	Engage Description

Short code

Resource	Description
GET /api/v2/data_from_code	Get full engage url with params from short code
GET /api/v2/create_short_code	Create short code record for url

Single gifts

Resource	Description
POST /api/v2/single_gift	Guest gift endpoint

Sms gift

Resource	Description
POST /api/v2/multiple_sms_gift	Process a gift with a breakdown
POST /api/v2/sms_gift	Setup a gift with a giver phone, fund, and amount
PUT /api/v2/sms_gift	Update a gift with a new amount or get response to menu
POST /api/v2/sms_gift/process_decision	Confirm a gift is good to go
POST /api/v2/sms_gift/menu	Get menu of giving funds

Sst payment methods

Resource	Description
GET /api/v2/sst_payment_methods	List of SST payment methods

Suf users

Resource	Description
GET /api/v2/users/:id	Get SUF User information

System

Resource	Description
GET /api/v2/system	Return fgsystem row information

Terms

Resource	Description
GET /api/v2/system/terms	Return default terms based on database from Provision Code retrieved from Header

Test error

Resource	Description
GET /api/v2/test_error	A test error

Transaction reversal notice

Resource	Description
GET /api/v2/send_failed_transaction_notifications/:response_message/:transaction_guid	Sends failed transaction notifications

Ucc

Resource	Description
POST /api/v2ucc/accept_terms_of_use
GET /api/v2/ucc/full_profile	Get full profile
GET /api/v2ucc/affiliated_conferences	Get all conferences the logged in user has positions with
GET /api/v2ucc/find_individual_id	Get all conferences the logged in user has positions with
GET /api/v2ucc/request_account	Request an account for UCC Engage

Ucc data

Resource	Description
GET /api/v2ucc/conferences	Get list of conferences
GET /api/v2ucc/associations	Get list of associations
GET /api/v2ucc/get_all_regions	Get all regions
GET /api/v2ucc/languages	Get list of languages from MCS
GET /api/v2ucc/skills	Get list of skills from MCS

Ucc data hub

Resource	Description
GET /api/v2ucc/:person_id/data	Get list of conferences

Ucc minister data

Resource	Description
GET /api/v2ucc/get_minister_data	Get saved minister data
POST /api/v2ucc/save_minister_data	Save UCC minister data
GET /api/v2ucc/get_genders	Get all gender options
GET /api/v2ucc/get_legal_genders	Get all legal gender options
GET /api/v2ucc/get_race_ethnicities	Get all heritages
GET /api/v2ucc/get_pronouns	Get all pronouns
GET /api/v2ucc/get_sexual_orientation	Get all sexual orientation options

Update minister snapshot

Resource	Description
POST /api/v2ucc/update_snapshot_basic_info	Update a ministers snapshot
POST /api/v2/ucc/update_availability	Update a minister snapshot avaialability
POST /api/v2ucc/update_authorization	Update a ministers snapshot authorization/standing
POST /api/v2ucc/update_gifts_talents	Update a ministers gifts and talents

Users

Resource	Description
GET /api/v2/users	List of Users

Validation

Resource	Description
GET /api/v2/ucc/get_profiles_for_validation	Get profiles that have been submitted for validation
GET /api/v2/ucc/get_profile_information	Get Profile Information
GET /api/v2/ucc/get_positions_for_validation
GET /api/v2ucc/get_position_information
GET /api/v2/ucc/get_validator_information	Get Validator Information
POST /api/v2/ucc/validate_profile	Validate or Set profile to Review
POST /api/v2/ucc/validate_position	Validate or Set Church profile to Review

Visitations

Resource	Description
GET /api/v2/individuals/:individual_id/visitations	List all visitations for an individual
GET /api/v2/individuals/:individual_id/visitations/:id	Show a Specific Visitation
GET /api/v2/visitations/:id	Show a specific visitation
POST /api/v2/individuals/:individual_id/visitations	Create a visitation record
PUT /api/v2/individuals/:individual_id/visitations/:id	Edit a visitation record
DELETE /api/v2/individuals/:individual_id/visitations/:id	Delete a visitation record