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 forms

Requires `FORMS_READ` or `FORMS_SUBMIT` (`FORMS_WRITE` covers both). Callers holding `FORMS_SUBMIT` without `FORMS_READ`, which includes every app caller (apps can't be granted `FORMS_READ`), see only published forms with `showInCommunity` on, with the real `submissionCount` and only the render part of `settings` (`respondent`, `theme`, `css`; see `Form`). A 403 to an app names `FORMS_SUBMIT`, the scope an app can be granted.

GET
/forms

Requires FORMS_READ or FORMS_SUBMIT (FORMS_WRITE covers both). Callers holding FORMS_SUBMIT without FORMS_READ, which includes every app caller (apps can't be granted FORMS_READ), see only published forms with showInCommunity on, with the real submissionCount and only the render part of settings (respondent, theme, css; see Form). A 403 to an app names FORMS_SUBMIT, the scope an app can be granted.

Authorization

x-api-key<token>

In: header

Query Parameters

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

Response Body

application/json

application/json

curl -X GET "https://example.com/forms"
{  "data": [    {      "id": "string",      "workspaceId": "string",      "name": "string",      "slug": "string",      "publicSlug": "string",      "status": "DRAFT",      "description": "string",      "fields": {        "sections": [          {            "id": "string",            "title": "string",            "description": "string",            "fields": [              {                "id": "string",                "slug": "string",                "type": "string",                "label": "string",                "required": true,                "placeholder": "string",                "helperText": "string",                "options": [                  {                    "value": "string",                    "label": "string",                    "reveals": {}                  }                ],                "defaultValue": "string",                "description": "string"              }            ]          }        ]      },      "settings": {},      "showInCommunity": true,      "submissionCount": 0    }  ],  "meta": {    "total": 0,    "limit": 0,    "offset": 0  }}

Set one registrant's attendance PUT

Requires `EVENT_REGISTRATIONS_WRITE` (`CONTACTS_WRITE` also works). Send `memberId` (required for app callers) or `contactId`. The registrant must be registered. Changing attendance emits `event.attendance_classified`. App callers can only use events with `showInCommunity` on, and their response leaves out `contact` and `opportunityId`.

Create a form POST

Next Page