forms

Embed

<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/public/lists/{ws}

Public lists a workspace chose to show (JSON). Subscribe with POST /p/lists/{ws} or the forms ingest endpoints

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

wsstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/public/lists/{ws}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

namestringrequired

descriptionstringrequired

nextCursorstringrequired

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/public/lists/{ws}

GEThttps://hermeticor.com/p/lists/{ws}

Public lists directory: pick lists and subscribe

Parameters

wsstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/p/lists/{ws}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

"string"

4XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

5XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

POSThttps://hermeticor.com/p/lists/{ws}

Subscribe to the chosen public lists

Parameters

wsstringpathrequired

Request body

application/json

{}

Code samples

cURL

curl -X POST "https://hermeticor.com/p/lists/{ws}" \
  -H "Content-Type: application/json" \
  -d '{}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

"string"

4XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

5XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

GEThttps://hermeticor.com/p/me/{*}

Download or delete your data

Parameters

*stringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/p/me/{*}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

"string"

4XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

5XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

POSThttps://hermeticor.com/p/me/{*}

Export or erase your data

Parameters

*stringpathrequired

Request body

application/json

{}

Code samples

cURL

curl -X POST "https://hermeticor.com/p/me/{*}" \
  -H "Content-Type: application/json" \
  -d '{}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

"string"

4XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

5XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

POSThttps://hermeticor.com/ingest/v1/subscribe

Subscribe an email/phone with the consent text the visitor saw

Request body

application/json

emailstring

phonestring

channelsstring[]

= ["email"]

listIdstring

topicIdstring

consentTextstringrequired

consentVersionstring

= 1

pageUrlstring

anonymousIdstring

propertiesobject

{
  "email": "string",
  "phone": "string",
  "channels": [
    "email"
  ],
  "listId": "string",
  "topicId": "string",
  "consentText": "string",
  "consentVersion": "1",
  "pageUrl": "string",
  "anonymousId": "string",
  "properties": {}
}

Code samples

cURL

curl -X POST "https://hermeticor.com/ingest/v1/subscribe" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","phone":"string","channels":["email"],"listId":"string","topicId":"string","consentText":"string","consentVersion":"1","pageUrl":"string","anonymousId":"string","properties":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

5XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

POSThttps://hermeticor.com/ingest/v1/back-in-stock

Ask to be notified when a catalog product is back in stock or drops in price

Request body

application/json

emailstring

phonestring

externalIdstringrequired

kindstring

back_in_stock | price_drop = back_in_stock

variantIdstring

channelstring

email | sms | push

{
  "email": "string",
  "phone": "string",
  "externalId": "string",
  "kind": "back_in_stock",
  "variantId": "string",
  "channel": "email"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/ingest/v1/back-in-stock" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","phone":"string","externalId":"string","kind":"back_in_stock","variantId":"string","channel":"email"}'

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Same as 202 · POST /ingest/v1/subscribe

4XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

5XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

POSThttps://hermeticor.com/v1/profiles/subscribe

Subscribe a contact through a published form: consent starts as pending and the form double opt-in email goes out. `data` is the form field map including its consent checkbox.

Request body

application/json

dataobjectrequired

pageUrlstring

formIdstringrequired

{
  "data": {},
  "pageUrl": "string",
  "formId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/profiles/subscribe" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data":{},"pageUrl":"string","formId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true,
  "success": {
    "type": "message",
    "text": "string",
    "title": "string"
  },
  "pendingConfirmation": true,
  "outcome": "success",
  "spin": {
    "index": 0
  },
  "stepToken": "string"
}

Schema

okbooleanrequired

true

successSuccessVariant4 | SuccessVariant5 | SuccessVariant6 | SuccessVariant7required

pendingConfirmationbooleanrequired

outcomestring

success | already_subscribed

spinobject

Show child parameters

indexintegerrequired

stepTokenstring

4XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

5XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

POSThttps://hermeticor.com/v1/forms/query

Filter forms with a typed where / orderBy / limit / offset (fields are an allowlist; read "fields" in the result)

Request body

application/json

whereWhereItem[]

= []

Show child parameters

fieldstringrequired

opstringrequired

eq | ne | gt | gte | lt | lte | contains | starts_with | in | is_null | not_null

valuestring | number | boolean | string | number[]

orderByobject[]

= []

Show child parameters

fieldstringrequired

dirstring

asc | desc = asc

limitinteger

= 50

offsetinteger

= 0

{
  "where": [],
  "orderBy": [],
  "limit": 50,
  "offset": 0
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/forms/query" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"where":[],"orderBy":[],"limit":50,"offset":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {}
  ],
  "fields": [
    "string"
  ],
  "hasMore": true
}

Schema

itemsobject[]required

fieldsstring[]required

hasMorebooleanrequired

4XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

5XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

GEThttps://hermeticor.com/ingest/v1/forms/visitor

Audience flags for on-site targeting: booleans only (known, subscriber, membership of each targeted list/segment, targeted countries)

Parameters

aidstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/ingest/v1/forms/visitor" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "known": true,
  "subscriber": true,
  "lists": {},
  "segments": {},
  "countries": {}
}

Schema

knownbooleanrequired

subscriberbooleanrequired

listsobjectrequired

segmentsobjectrequired

countriesobjectrequired

4XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

5XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

GEThttps://hermeticor.com/ingest/v1/forms/{id}/companies

Company name suggestions for a form company field (names only)

Parameters

qstringqueryrequired

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/ingest/v1/forms/{id}/companies?q=<q>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    "string"
  ],
  "nextCursor": "string"
}

Schema

itemsstring[]required

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

5XX Default Response

Same as 4XX · GET /v1/public/lists/{ws}

Next part

Updated Nov 8, 2026

Was this page helpful?