getFormsDataByMarker

Searching for form data by text identifier (marker).

Description

This method retrieves a specific form data object by its marker from the API. It accepts a marker parameter as the marker of the form data. It returns a Promise that resolves to an array of objects of type FormDataEntity.

FormData.getFormsDataByMarker(

marker, langCode, offset, limit

);

Parameters schema

Schema

marker(required): string
Marker of the form
example: "contact_form"

langCode: string
Language code. Default: "en_US"
example: "en_US"

offset: number
Parameter for pagination. Default: 0
example: 0

limit: number
Parameter for pagination. Default: 30
example: 30

Examples

Minimal example

const response = await FormData.getFormsDataByMarker('my-marker');

Example with attributes

const response = await FormData.getFormsDataByMarker('my-marker', 'en_US', 0, 30);

Example response

{
  "items": [
    {
      "id": 285,
      "formIdentifier": "test-form",
      "time": "2025-07-21T01:54:30.043Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form"
    },
    {
      "id": 283,
      "formIdentifier": "test-form",
      "time": "2025-07-21T01:49:33.957Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form"
    },
    {
      "id": 281,
      "formIdentifier": "test-form",
      "time": "2025-07-21T01:44:11.296Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form"
    },
    "..."
  ],
  "total": 169
}

Response schema

Schema: IFormsDataEntity

items: IFormDataEntity[]
Array of form data objects.
example:

[
  {
    "id": 1,
    "formIdentifier": "form",
    "time": "2025-06-06T19:07:45.993Z",
    "formData": {},
    "attributeSetIdentifier": "form",
    "actionMessage": "Action message string"
  }
]

total: number
Total number of found records.
example: NaN

---