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, isExtended, 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": 14,
  "entityparentIdentifier": 167,
  "userIdentifier": "",
  "status": [
    "new",
    "approved"
  ],
  "dateFrom": "2025-01-01",
  "dateTo": ""
}

isExtended: number
Flag for getting additional fields
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

By default, you can retrieve 10 objects. This is due to the record limit in the module's permissions settings.
For pagination to work correctly, you need to configure Module permissions according to your needs in the corresponding section.

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": 3502,
      "formIdentifier": "test-form",
      "time": "2026-01-10T00:49:16.301Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content"
    },
    {
      "id": 3500,
      "formIdentifier": "test-form",
      "time": "2026-01-10T00:47:29.594Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content"
    },
    {
      "id": 3483,
      "formIdentifier": "test-form",
      "time": "2026-01-08T11:23:28.559Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content"
    },
    "..."
  ],
  "total": 522
}

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
  }
]

items.id: number
The unique identifier of the form page.
example: 12345

items.parentId: null | number
The unique identifier of the parent form page.
example: 123

items.formIdentifier: string
The identifier of the page.
example: "contact_form"

items.depth: number
**
example: 1

items.ip: string | null
Ip.
example: '127.0.0.1'

items.fingerprint: string | null
Fingerprint.
example: 'fingerprint'

items.status: string | null
Status.
example: 'approved'

items.userIdentifier: string | null
Text identifier (marker) of the user.
example: "admin"

items.formData: FormDataType[]
Form data.
example:

[
  {
    "marker": "name",
    "type": "string",
    "value": "Test"
  }
]

items.attributeSetIdentifier: string | null
Text identifier (marker) of the used attribute set.
example: "product_attributes"

items.time: Date | string
The identifier of the form.
example: "2023-10-01T12:00:00Z"

items.entityIdentifier: string
Text identifier (marker) of the entity.
example: "test"

items.isUserAdmin: boolean
Is user admin.
example: true

items.formModuleConfigId: number
Form module config Id.
example: 2

items.moduleIdentifier: number
Form module config Id.
example: 2

items.entityId: number
Form module config Id.
example: 2

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

---