forms

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-forms"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/3a095c68-d07c-4776-8a75-070cf1437150/social-card.svg?v=3e7ae33eec8b" alt="forms" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/forms/{id}/versions

Published versions, newest first; includes the A/B experiment the form belongs to

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/forms/{id}/versions" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "abExperimentId": "string",
  "items": [
    {
      "id": "string",
      "formId": "string",
      "publishedAt": "2024-01-01T00:00:00Z",
      "live": true
    }
  ]
}
Schema
abExperimentIdstringrequired
itemsobject[]required
Show child parameters
idstringrequired
formIdstringrequired
publishedAtstringrequired
livebooleanrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

GEThttps://hermeticor.com/v1/forms/{id}/versions/{versionId}

Parameters

idstringpathrequired
versionIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/forms/{id}/versions/{versionId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string"
}
Schema
idstringrequired
4XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

5XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

POSThttps://hermeticor.com/v1/forms/{id}/versions/{versionId}/restore

Copy a version into the draft; publish to make it live

Parameters

idstringpathrequired
versionIdstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/forms/{id}/versions/{versionId}/restore" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "name": "string",
  "kind": "embed",
  "status": "draft"
}
Schema
idstringrequired
namestringrequired
kindstringrequired
embed | popup | flyout | full_page | preference_center | bar
statusstringrequired
draft | published | archived
4XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

5XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

GEThttps://hermeticor.com/v1/forms/{id}/step-funnel

Per-step funnel of a multi-step form (on-site form_step events): visitors who reached, completed and skipped each step, from..to inclusive (UTC days)

Parameters

fromstringqueryrequired
tostringqueryrequired
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/forms/{id}/step-funnel?from=<from>&to=<to>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "steps": [
    {
      "step": 0,
      "reached": 0,
      "completed": 0,
      "skipped": 0
    }
  ]
}
Schema
stepsobject[]required
Show child parameters
stepintegerrequired
reachedintegerrequired
completedintegerrequired
skippedintegerrequired
4XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

5XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

GEThttps://hermeticor.com/v1/forms/{id}/summary

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/forms/{id}/summary" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "total": 0,
  "fields": [
    {
      "key": "string",
      "label": "string",
      "type": "string",
      "answered": 0,
      "counts": [
        {
          "value": "string",
          "count": 0
        }
      ]
    }
  ]
}
Schema
totalintegerrequired
fieldsobject[]required
Show child parameters
keystringrequired
labelstringrequired
typestringrequired
answeredintegerrequired
countsValuesItem[]required
Show child parameters
valuestringrequired
countintegerrequired
4XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

5XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

GEThttps://hermeticor.com/v1/forms/{id}/submissions

Submissions of one form, newest first; `profileId` narrows to one contact

Parameters

limitintegerquery
= 50
cursorstringquery
profileIdstringquery
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/forms/{id}/submissions" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "formId": "string",
      "profileId": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem74[]required
Show child parameters
idstringrequired
formIdstringrequired
profileIdstringrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

5XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

GEThttps://hermeticor.com/v1/forms/{id}/submissions/export.csv

Every submission as CSV, oldest first (one column per field)

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/forms/{id}/submissions/export.csv" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

5XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

GEThttps://hermeticor.com/v1/forms/{id}/submissions/{submissionId}

Parameters

idstringpathrequired
submissionIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/forms/{id}/submissions/{submissionId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "formId": "string",
  "profileId": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
formIdstringrequired
profileIdstringrequired
createdAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

5XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

DELETEhttps://hermeticor.com/v1/forms/{id}/submissions/{submissionId}

Delete one submission (the consent records it created stay as proof)

Parameters

idstringpathrequired
submissionIdstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/forms/{id}/submissions/{submissionId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

5XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

POSThttps://hermeticor.com/v1/forms/{id}/submissions/{submissionId}/resend-confirmation

Send the double opt-in email again for a submission still waiting (once per hour)

Parameters

idstringpathrequired
submissionIdstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/forms/{id}/submissions/{submissionId}/resend-confirmation" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · DELETE /v1/forms/{id}/submissions/{submissionId}

4XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

5XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

GEThttps://hermeticor.com/v1/form-submissions

Every form submission of one contact, across forms

Parameters

limitintegerquery
= 50
cursorstringquery
profileIdstringqueryrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/form-submissions?profileId=<profileId>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/forms/{id}/submissions

4XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

5XX Default Response

Same as 4XX · GET /v1/forms/{id}/versions

Updated