List, read and delete forms

These calls find, read and delete the forms that your integration has created. They use the same host and token as Create a Smartform.

Find Smartforms and forms

Call	What it returns
`GET /Integrations/active`	The active Smartforms you can use, with `id`, `name`, `process` and tags.
`GET /Integrations/active/list`	The active Smartforms with more detail, such as folders, dates and archive settings. Narrow the list with the query parameters `integration` and `integrationobject`.
`GET /Integrations/{dialogDefinitionId}`	The definition of one Smartform.
`GET /Integrations/{dialogDefinitionId}/fields`	The fields of a Smartform, with `id`, `name` and `type`.
`GET /Integrations/{dialogDefinitionId}/participatingParties`	The participating parties of a Smartform. See Participating parties.
`GET /Integrations/inprogress`	Multi-step forms that are in progress, with the Smartform and the current step.

Read a form

To read a whole form, use GET /Integrations/dialogValues/{id}. See Reading a form back.

To read one answer or one uploaded file:

Call	What it returns
`GET /Integrations/{id}/property/{property}/value`	The value of one property, as `{ "value": ... }`. A property without a value is answered with `404`.
`GET /Integrations/{id}/property/{property}/file/{fileId}`	The uploaded file with that id, as a download.

Delete forms

DELETE /Integrations/dialogvalues/{id} deletes one form. It answers 404 if the form does not exist in your company.
DELETE /Integrations/dialogvalues/bulk deletes several. Send the ids in the body. Ids that do not belong to your company are skipped, and the call answers 200 either way.

{
    "dialogValuesIds": [
        "64e4a31fdf775xxxxxxxxxx1",
        "64e4a31fdf775xxxxxxxxxx2"
    ]
}

📝 Note: Deleting a form removes it for good. Bulk delete is run in the background, so the forms can take a moment to disappear.

Test your credentials

GET /Integrations/ping answers 200 with { "message": "Ping received" } when the host is reachable and your token is accepted. It also answers with an environment in the path, for example /Test/Integrations/ping, so you can check that a host serves the environment form. The reply is the same for every environment.

GET https://api.smartforms.metaforce.net/Integrations/ping