Follow

List of Available Methods

Provided below is a list of available methods for our Rest-Based API.

 

 

Contact Search

Contact Search by Name Fetch 

returns a paged list of limited Contact Information, including the ContactID

Contact Search by Letter Fetch 

returns a paged list of limited Contact Information, including the ContactID, based on a partial name or a single character.

        Contact Search POST 

        returns a paged list of Basic Contact Information, including the ContactID, based on the specified field, operand, and field value. 

       

Contact Methods

Contact by ContactID Fetch

returns a contact record by ContactID

Master Fetch By ContactID

returns a contact record by ContactID, as well as its associated Address, Phone, and Internet Address data

Contact by ContactID Fetch (Basic)

returns a simplified contact record by ContactID

Contact by ContactID Put

creates or updates a Contact Record by ContactID

Contact by ContactID Delete

marks a record as deleted by ContactID

Contact Details by ContactID Fetch

returns contact record details by ContactID

Contact Details by ContactID Put

updates the contact record fields associated with the Details by ContactID GET method.

*Note: For Contact Record Creation, please see the Contact PUT and Contact Basic PUT method

Family By ContactID Fetch

returns a list of  family related contact records associated with a specific contact record

Memberships By ContactID Fetch

returns a list of professional or personal associated contact records for a specific contact record

Personal Profile by ContactID Fetch

returns the Personal Profile information associated with a contact record

Personal Profile by ContactID PUT

Updates a specific Contact Record's Personal Profile information.

Important Information by ContactID Fetch

returns a the important information associated with a contact record

Important Information by ContactID PUT

Updates a specific Contact Record's Important Information.

Departments by ContactID Fetch

returns a list of  departments for a specific non-individual contact record

UDFs by ContactID Fetch

returns a list of User-Defined fields for a Contact record.

UDF By User-Defined Field ID Put

creates or updates a User-Defined field based on the User-Defined Field ID.

 

 

Address Methods

Addresses by ContactID Fetch

returns a list of Address records for a ContactID

Address by AddressID Put

creates or updates an Address record by AddressID and Contact

Address by AddressID Delete

marks a record as deleted by AddressID

Phones by ContactID Fetch

returns a list of Phone records for a ContactID

Phone by PhoneID Put

creates or updates a Phone record by PhoneID and Contact

Phone by PhoneID Delete

marks a phone record as deleted by PhoneID

Internet Addresses by ContactID Fetch

returns a list of Internet Addresses records for a ContactID

Internet Address by InternetID Put

creates or updates an Internet Address record by AddressID and Contact

Internet Address by InternetID Delete

marks a record as deleted by InternetID

Assets & Liabilities Fetch

returns a full list of a contact's Assets and Liabilities.

 

Note Methods

Notes by ContactID Fetch

returns a paged list of notes for a specific contact record

Notes By ContactID Put

Creates or Updates a Note Record by NoteID.

Recently Added Notes Fetch

returns a paged list of Recently Added Notes

 

Account Methods

Accounts by ContactID Fetch

returns a paged list of Accounts associated with a specific Contact Record

Account By ContactID Put

Creates or Updates an Account Record by AccountID for a specific contact.

Account Assets by AccountID Fetch

returns a list of Assets associated with an Account.

 

Calendar Methods

Activities by User Fetch

returns a paged list of Activities associated with a specific User

Activities by User Fetch (Basic)

returns a simplified paged list of Activities associated with a specific User

Activities by ActivityID Fetch

returns an Activity record by ActivityID

Activities by ActivityID PUT

creates or updates an Activity record

Activity Mark Complete PUT

updates an activity record as completed by ActivityID

Recently Added Activities GET

retrieves a list of recently added activity records

Activities by ContactID Fetch

returns a paged list of Activities associated with a specific Contact

Activities by ContactID Fetch (Basic)

returns a simplified paged list of Activities associated with a specific Contact

 

Tag Groups Methods

Tag Group by TagID Fetch

returns a Tag Group record by TagID

Tag Group's Contacts by TagID Fetch

returns a list of contacts associated with a tag group.

Contact's Tag Groups Fetch

returns a list of tag groups associated associated with a ContactID.

 

Settings Methods

Activity Type List Fetch

returns a list of activity types with the corresponding Activity Code

Contact Status List Fetch

returns a list of contact statuses with the corresponding Contact Status Code.

Contact Category List Fetch

returns a list of Contact Categories with the corresponding Contact Category Code.

Contact Source List Fetch

returns a list of Contact Sources with the corresponding Contact Source Code.

Master Category List Fetch

returns a Master Category List with the corresponding MCL Code.

Salutation List Fetch

returns a list of Salutations with the corresponding Salutation Code.

Servicing Advisor List Fetch

returns a list of Servicing Advisors with the corresponding Servicing Advisor Code.

Writing Advisor List Fetch

returns a list of Writing Advisors with the corresponding Writing Advisor Code.

User-Defined Fields Fetch

returns a list of User-defined fields with the corresponding UDF Code.

Tag Groups Fetch

returns a list of Tag Groups for a user's Database.

 

SSO & UserKey

Single Sign-On

returns a URL for Single Sign-On based on the specified endpoint.

UserKey Retrieval

returns a UserKey in exchange for the Username and Password specified in the Authentication.

 

 

Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk