Forms

FaxStore

Prerequisites
Installation & Setup
API
Config File
Developer Mode
Developer Tools
Enable Debug Mode
Events
Extensions
Features
Integrations
License System Extension
Permissions
Updating FaxStore

Weblutions Documentation > FaxStore > API > Forms

Forms

The Forms API for FaxStore allows you to create, update, delete, and retrieve form templates. It simplifies the management of form data and user interactions on your site.

GET /api/forms

Returns all forms on the site. This doesn't return submissions.

Parameters:

authorization [Header] A valid API token

Response: ^[Expand]

2xx:

[
  {
    "id": 4,
    "title": "Test Form",
    "urlId": "testone",
    "fields": "[{"type":"text","q":"Text Input ","opts":null},{"type":"area","q":"Text Area Here","opts":null}]",
    "viewers": "",
    "allowReplies": 1,
    "createdAt": "1661778196468",
    "discordChannel": "",
    "rawFields": "Text Input :Text Area Here",
    "description": ""
  },
  ...
]

4xx:

Forms not found.

GET /api/forms/:id

Returns the provided form.

Parameters:

`authorization`	[Header] A valid API token
`id`	[URL] The form database ID

Response: ^[Expand]

2xx:

{
  "id": 4,
  "title": "Test Form",
  "urlId": "testone",
  "fields": "[{"type":"text","q":"Text Input ","opts":null},{"type":"area","q":"Text Area Here","opts":null}]",
  "viewers": "",
  "allowReplies": 1,
  "createdAt": "1661778196468",
  "discordChannel": "",
  "rawFields": "Text Input :Text Area Here",
  "description": ""
}

4xx:

Form not found.

DELETE /api/forms/:id

Deletes the form

Parameters:

`authorization`	[Header] A valid API token
`id`	[URL] The form database ID

Response: ^[Expand]

2xx:

(no content)

4xx:

Form not found.

Suggest an edit

Review this page

faxes

4 months ago - updated (4 months ago)

forms api

1 recommend this page

Parameters:

Response: [Expand]

Parameters:

Response: [Expand]

Parameters:

Response: [Expand]

forms api

Response: ^[Expand]

Response: ^[Expand]

Response: ^[Expand]