Skip to main content

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*, formModuleConfigId*, body, isNested, langCode, offset, limit

);

Parameters schema​

Schema

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

formModuleConfigId(required): number
Form module configuration ID
example: 4

body: object
Request body
example:

{
  "entityIdentifier": "test",
  "userIdentifier": "",
  "status": "",
  "dateFrom": "2025-08-11",
  "dateTo": ""
}

isNested: any
Flag for getting hierarchical data
example: 1

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": 42,
      "parentId": null,
      "formIdentifier": "test-form",
      "depth": 0,
      "ip": null,
      "fingerprint": null,
      "status": null,
      "userIdentifier": null,
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "time": "2025-03-03T15:51:17.458Z",
      "entityIdentifier": "blog",
      "isUserAdmin": false,
      "formModuleConfigId": 2
    },
    {
      "id": 43,
      "parentId": null,
      "formIdentifier": "test-form",
      "depth": 0,
      "ip": null,
      "fingerprint": null,
      "status": null,
      "userIdentifier": null,
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "time": "2025-03-03T15:51:43.596Z",
      "entityIdentifier": "blog",
      "isUserAdmin": false,
      "formModuleConfigId": 2
    },
    {
      "id": 44,
      "parentId": null,
      "formIdentifier": "test-form",
      "depth": 0,
      "ip": null,
      "fingerprint": null,
      "status": null,
      "userIdentifier": null,
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "time": "2025-03-03T15:52:00.625Z",
      "entityIdentifier": "blog",
      "isUserAdmin": false,
      "formModuleConfigId": 2
    },
    "..."
  ],
  "total": 341
}

Response schema​

Schema: IFormsDataEntity

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

[
  {
    "id": 42,
    "parentId": null,
    "formIdentifier": "test-form",
    "depth": 0,
    "ip": null,
    "status": null,
    "userIdentifier": null,
    "formData": [
      {
        "marker": "name",
        "type": "string",
        "value": "Test"
      }
    ],
    "attributeSetIdentifier": "form",
    "time": "2025-03-03T15:51:17.458Z",
    "entityIdentifier": "blog",
    "isUserAdmin": false,
    "formModuleConfigId": 2
  }
]

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