PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List forms GETCreate a form POSTGenerate a form definition POSTGet a form GETUpdate a form PATCHDelete a form DELETEList submissions for a form GETSubmit a form as a member POSTGet a form submission GETUpdate a form submission PATCHDelete a form submission DELETE
Forms

List submissions for a form

GET
/forms/{formId}/submissions

Authorization

x-api-key<token>

In: header

Path Parameters

formId*string

Query Parameters

limit?integer
Rangevalue <= 100
Default50
offset?integer
Range0 <= value
Default0
source?string

Value in

  • "HOST"
  • "SITE"
  • "EMBED"

Response Body

application/json

curl -X GET "https://example.com/forms/string/submissions"
{  "data": [    {      "id": "string",      "formId": "string",      "source": "HOST",      "fields": {},      "status": "NEW",      "contactId": "string",      "customerId": "string",      "opportunityId": "string",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "total": 0,    "limit": 0,    "offset": 0  }}

Delete a form DELETE

Previous Page

Submit a form as a member POST

Requires `FORMS_SUBMIT` (`FORMS_WRITE` also works). Submits the published form for the member, like a member filling it in: the normal form side effects run (`form.submitted`, workflows, event registration for a linked event). Consent is never recorded through the API: the answers are stored with the submission, but marketing consent, guardian consent and the guardian email are not set on the contact. A member without a primary contact gets one, as for event registration. Callers holding `FORMS_SUBMIT` without `FORMS_READ` (every app caller) can only submit forms with `showInCommunity` on.