v1

latestOpenAPI 3.0.0Proprietary2026-08-06130577659.7 KB

Documents|Form data

Fetch form data list.

This endpoint allows you to retrieve a list of custom forms. geoCapture Custom forms can be used to create construction reports, for instance. geoCapture allows you to create unique form definitions for different use cases. In addition, a form can be automatically added to projects, if enabled in the form definition. If employees, tools or vehicles are referenced in the form definition, the completed form can also be added to these targets, if enabled in the form definition.

get/custom_form_data/fetch

Query parameters

filter[byIds][]integer[]

Filters the form data based on the internal IDs.

filter[byProjectIds][]integer[]

Filters the form data based on in internal project IDs.

filter[byEmployeeIds][]integer[]

Filters the form data based on the internal employee IDs.

filter[byTrackerIds][]integer[]

Filters the form data based on the internal vehicle IDs.

filter[byBeaconIds][]integer[]

Filters the form data based on the internal beacon IDs.

filter[byText]string

Filters the form data based on the text passed.

filter[byFormDefinitionIds][]integer[]

Filters the form data based on the form definition IDs.

filter[byExternalReference]string

Filters the form data based on the external reference.

filter[byStatus]string

Filters the form data based on the status.

Value	Description
NEW	New form data
FILLED	Already filled form data
REVIEW	Check form data
APPROVED	Approved by test distributor
COMPLETED	Completed form data
RESET	Resetted form data
BOOKED	Booked form data

filter[byOrderIds][]integer[]

Filters the form data based on the order IDs.

filter[byBounds]string

Example:52.37652038909364 7.605081948346127, 52.375099096475545 7.6082684126850175

Filters the form data based on the given rectangle

offsetinteger

Use this parameter to specify the number of records you want to skip before starting to collect the data from the result set.

limitinteger

The limit parameter defines the maximum number of records that can be retrieved in a single API request, with a max and default value set at 500 records.

Response

Success Response:

offsetinteger

Number of skipped records.

totalCountinteger

Total number of available form data. (Only calculated if offset is 0)

Example response

{
  "data": [
    {
      "latLng": [
        52.38127828631681,
        7.594243214018696
      ],
      "createdAt": "2015-02-20T12:59:21+01:00",
      "project": {
        "latLng": [
          52.38127828631681,
          7.594243214018696
        ]
      }
    }
  ]
}