API Endpoints (advanced)
Mike Kelly avatar
Written by Mike Kelly
Updated over a week ago

We are currently working towards a more full-featured REST API with proper documentation, and hope to have that live in early 2022. However, even now, MemberVault DOES have a very basic API that you can use to build custom integrations.

The path for all API endpoints follow this pattern.
https://xxx.vipmembervault.com/api/endpoint?apikey=XXX

Then just add your GET variables to the end of this like "&first_name=YYY" etc. You can easily test this in the browser and see what response you get.

Authentication

Our current API simply uses GET variables with an apikey that is unique to each account. On all of these endpoints, you simply need to set '?apikey=XXX' to get authenticated, and then add the variables needed for that endpoint.

To get your API key, in your admin head over to Integrations / Other. You'll see a block for the Webhooks API, and can get your key there.

get_courses

To get a list of all the products inside of an account in JSON format, call the "get_courses" endpoint. No extra fields needed.

ex.
https://xxx.vipmembervault.com/api/get_courses?apikey=XXX

add_user

To add a user to a product, call the "add_user" end point. You can pass in "-1" in as the course_id if you just want to add the user without giving them access to anything. Or you can pass in the course_id of the course from the "get_courses" endpoint above.

The api is smart enough not to create duplicate users. So if a user already exists, and you just want to add access to a product, you can use this endpoint, and we'll find the user and add give them access to the new product (course). Only the email and course_id fields are required.

Fields:
email - Required
course_id - Required
first_name
last_name

ex.
https://xxx.vipmembervault.com/api/add_user?apikey=XXX&email=X&first_name=X&last_name=X&course_id=109

remove_user

To remove a user from a product, use the remove_user endpoint. The only two fields for this are the user's email and the course_id. This will simply remove access to the product, it will NOT delete the user from the account.

Fields:


email - Required
course_id - Required

ex.
https://xxx.vipmembervault.com/api/remove_user?apikey=XXX&email=X&first_name=X&last_name=X&course_id=109

delete_user

To completely delete a user from your account, use the delete_user endpoint. This will delete the user AND all of their data, progress and quiz answers. ONLY use this endpoint if you want to COMPLETELY DELETE this user. This cannot be undone. You need only the email field.

Fields:
email - Required

ex.
https://xxx.vipmembervault.com/api/delete_user?apikey=XXX&email=X

Other Events

There is currently no way to subscribe to events inside of MemberVault via this API, but you can use Actions to call a webhook based on events. In the upcoming version 2 of our API, we plan to allow you to subscribe to events like we have for Zapier.

See our article on calling webhooks from MV here.



Questions? Reach out to us at hello@membervault.co, via chat support within your Admin account (available to paid users), or connect with other users within our FB Group, The MV Collaborative.

Did this answer your question?