Answer a Survey/Form From Your External Website via our API

By leveraging our API, you can customize the front-end of your experience and capture data on your external website.

With our API, you can submit data to our various engines to process the business logic according to your settings.  A great way of putting data in the system is by using our Survey API to submit data to forms.

Start out by setting up a new form in PeopleVine and then create your replicate HTML version of that form (if you search for it, there's an article on how to leverage HAPI to generate a form's HTML).

Once your form is setup, you can now get your API application and credentials ready.  Go to the company menu and click on API Credentials and API Applications to set them up.  Then ensure you have an API user too.  In the end, you should be able to create your AUTH object as such:

API Username – XXXX

API Password – XXXX


Username - XXXX

Password - XXXX

Company_no - XXXX

When looking to submit data to our forms engine, you can reference the API details below: 

API Docs: 


 Sample Object to Include in Answers

{"survey_no": 3402, "survey_field_no": 11798, "survey_answer": "Jane Doe", "response_id": "<GUID>" }

 Sample Call

{"answers": [{"survey_no": 123, "survey_field_no": 567890, "survey_answer": "Jane Doe", "response_id": "<GUID>" },{"survey_no": 1234, "survey_field_no": 678901, "survey_answer": "Sample Company", "response_id": "<GUID>" }], "auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "" } }

 Make sure the response_ID value is the same for all your answers.  This will allow us to group the data into a single response.

When looking to submit data to our CRM, you can reference the API details below:

API Docs: 

API Endpoint:

 "auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "" }, "customer": {"email": "", "mobile_number": "", "first_name": "", "customer_type": "customer", "customer_status": "active", “attributes”: [{“attribute_value”: “Value Here”, “attribute_type”: “Group Name Here”}] } }

 Sample Object

"customer" {
     "email" '',
     "opt_in_email" true,
     "attributes" [{
          "attribute_value" "VALUE HERE",
          "attribute_type" "GROUP NAME HERE"

Additional Help Tutorials

Find more ways to grow on PeopleVine.

Platform Updates 1st Half September 2020

We thought we'd share some of our notes on what was released so far in September.

Posted September 12, 2020

You Can Set What Gift Certificates are Valid For

When issuing a gift certificate to a person, you have the ability to select what the gift card is valid for. This allows you to issue a gift certificate to utilize for a series of events or a specific appointment type. When purchasing something else, this gift certificate will not be available for use.

Posted September 12, 2020

Answer a Survey/Form From Your External Website via our API

By leveraging our API, you can customize the front-end of your experience and capture data on your external website.

Posted September 10, 2020

Setup a Certificate of Completion, Diploma or Other Important Documents for Your Members After Achieving a Goal

With our image generator + text you have the ability to overlay messages over your existing graphics.

Posted September 9, 2020

Set the Time Tickets Go On Sale and Off Sale, Not Just the Date

You now have the ability to set the time that tickets should go on sale and off sale.

Posted September 4, 2020

Setup an Event and Enable an External Party to Manage the Event

You can enable your partners access to event details without giving them access to the whole platform.

Posted September 4, 2020

Use SAML based SSO Login for Your Website or App

You can leverage our /login/sso to get started with signing into your member portal with one-click SSO.

Posted September 1, 2020

Gain More Control Over Automating Membership Activities with New Triggers

We added several new triggers enabling you to setup automated activities after certain activities happen.

Posted August 28, 2020

As We Close Out Month 8 of 2020 - Here Are Some Noticeable Updates

We added a few updates the last week of August, here are a few to highlight.

Posted August 28, 2020

Members Can See Open Orders to Pay and Close

Members can now see open orders in their order history to make it a two-click pay and close the check experience.

Posted August 28, 2020

Create Multiple Unique Branded Experiences with One CRM/Backend

You can setup content pages to only display on certain domain names when overriding our out of the box pages.

Posted August 27, 2020

Aloha - See How You Can Split Checks to Allow Multiple Member Payments

Check out this video to see how you can split a check and/or setup separate checks to allow multiple members to pay to their house account using Aloha.

Posted August 26, 2020

Setup a Delivery Window to Hand Delivery Orders to your People

You can setup a custom delivery scheduler where you can control the available slots and staff handling the deliveries.

Posted August 18, 2020

Sell Products that Are Visible to Member's Only

You can setup a product catalog to display only to active members of specific groups.

Posted August 18, 2020

Setup Your eCommerce Product Catalog from a Spreadsheet

Are you ready to launch e-commerce to allow your members to purchase your food, beverages or merch? Check out this tutorial to get started with a simple excel spreadsheet.

Posted August 14, 2020

© PeopleVine 2020. Powered by PeopleVine. Terms of use | Privacy & cookies