📘 VPSUForm REST API Documentation

🔐 Authentication

Authentication is handled via the VPSUForm Plugin. Inside the plugin, you can find the API Key & Site Key in the Zapier section.

URL:

https://YOUR_SITE_URL/wp-json/vform/v1/submit

Method: POST

🔗 Example Request (cURL)

curl --location --request POST 'https://YOUR_SITE_URL/wp-json/vform/v1/submit?apikey=YOUR_API_KEY'

✅ Success Response

[
  {
    "message": "Success"
  }
]

❌ Failed Response

[
  {
    "message": "Unauthorized"
  }
]

📥 Get VPSUForm Entries

GET /{form_id}/entries

Fetch entries for a specific form.

URL:

https://YOUR_SITE_URL/wp-json/vform/v1/{form_id}/entries?apikey=YOUR_API_KEY

Method: GET

Example

https://vpsuform.info/wp-json/vform/v1/123/entries?apikey=xxxxxx

Response

[
  {
    "id": "1",
    "firstname": "VPSUform",
    "middlename": "",
    "lastname": "Team",
    "Email": "support@vform.info",
    "Upload": "No file was uploaded"
  }
]

📄 List All Forms

GET /allforms

Returns all published VPSUForm forms.

URL:

https://YOUR_SITE_URL/wp-json/vform/v1/allforms?apikey=YOUR_API_KEY

Method: GET

Response

[
  {
    "id": "6",
    "formname": "First Form"
  }
]

🚫 Error Response

If something goes wrong (missing form, invalid data, etc.), you’ll receive:

Response

[]