---
title: "Fetch form data list."
method: GET
path: "/custom_form_data/fetch"
tags: ["Documents|Form data"]
---

# Fetch form data list.

`GET /custom_form_data/fetch`

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.

## Query parameters

- `filter[byIds][]` integer[]
- `filter[byProjectIds][]` integer[]
- `filter[byEmployeeIds][]` integer[]
- `filter[byTrackerIds][]` integer[]
- `filter[byBeaconIds][]` integer[]
- `filter[byText]` string
- `filter[byFormDefinitionIds][]` integer[]
- `filter[byExternalReference]` string
- `filter[byStatus]` string
- `filter[byOrderIds][]` integer[]
- `filter[byBounds]` string
- `offset` integer
- `limit` integer

## Response `200`

Success Response:

- StandardCustomFormDataFetchResponse
  - `data` object[] — The form data.
    - `id` integer — The internal ID.
    - `name` string — Name of the form
    - `latLng` number[] — Represents a geo coordinate. An array of two double values, representing the latitude and longitude.
    - `status` string — Status of the form. | Value | Description | |------------|---------------------------------------| | NEW | Freshly created | | FILLED | Filled out form | | REVIEW | Approval pending | | APPROVED | Approved via associated approval rule | | COMPLETED | Manually approved via user | | REJECTED | Rejected via associated approval rule | | RESET | Approval reverted | | DELETED | Deleted |
    - `createdAt` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `project` StandardCustomFormDataBaseProjectItem
      - `id` integer — The internal project ID.
      - `reference` string — The project number.
      - `importSource` string — External data source from which this project originated.
      - `importKey` string — External ID from the respective data source.
      - `name` string — The project name. (max. 255 characters)
      - `description` string — The project description.
      - `extraName1` string — The name1 address addition. (max. 255 characters)
      - `extraName2` string — The name2 address addition. (max. 255 characters)
      - `extraName3` string — The name3 address addition. (max. 255 characters)
      - `street` string — The street.
      - `zipCode` string — The zip code.
      - `city` string — The city.
      - `countryCode` string — The two-digit ISO 3166 country code.
      - `latLng` number[] — Represents a geo coordinate. An array of two double values, representing the latitude and longitude.
      - `costCenter` string — The cost center. (max. 64 characters)
    - `employee` StandardCustomFormDataBaseEmployeeItem
      - `id` integer — The internal employee ID.
      - `reference` string — The personal number. (max. 20 characters)
      - `cardNumber` string — The driver card number.
      - `importSource` string — External data source from which this employee originates. (max. 16 characters)
      - `importKey` string — External ID from the respective data source. (max. 64 characters)
      - `firstName` string — The first name of the employee. (max. 128 characters)
      - `lastName` string — The last name of the Employee. (max. 128 characters)
      - `name` string — This field is deprecated. Please use firstName The complete Name of the Employee If first name or last name is set, name is ignored.
    - `definitionVersion` integer — Version of the form definition.
    - `employees` object[] — Form's employees.
      - `id` integer — The internal employee ID.
      - `reference` string — The personal number. (max. 20 characters)
      - `cardNumber` string — The driver card number.
      - `importSource` string — External data source from which this employee originates. (max. 16 characters)
      - `importKey` string — External ID from the respective data source. (max. 64 characters)
      - `firstName` string — The first name of the employee. (max. 128 characters)
      - `lastName` string — The last name of the Employee. (max. 128 characters)
      - `name` string — This field is deprecated. Please use firstName The complete Name of the Employee If first name or last name is set, name is ignored.
    - `trackers` object[] — Form's vehicles.
      - `id` integer — The internal vehicle ID.
      - `identifier` string — The customer-specific ID. (max. 64 characters)
      - `inventoryNumber` string — The inventory number. (max. 128 characters)
      - `licenseNumber` string — The vehicle license plate. (max. 255 characters)
      - `identificationNumber` string — The vehicle identification number. (max. 24 characters)
      - `importSource` string — External data source from which this vehicle originates. (max. 64 characters)
      - `importKey` string — External ID from the respective data source. (max. 64 characters)
      - `name` string — The vehicle name. (max. 255 characters)
    - `beacons` object[] — Form's beacons.
      - `id` integer — The internal ID.
      - `uuid` string — The beacon UUID as hexadecimal value.
      - `macAddress` string — The beacon MAC address.
      - `name` string — The name of the beacon. (max. 255 characters)
      - `objectIdentifier` string — External, customer specific ID of the object the beacon is attached to. (max. 64 characters)
      - `objectSerialNumber` string — Serial number of object, the beacon is attached to. (max. 128 characters)
    - `countMediaData` integer — Count of form's media data.
  - `offset` integer — Number of skipped records.
  - `totalCount` integer — Total number of available form data. (Only calculated if offset is 0)

---

[API](https://skmtc.net/geocapture/apis/geocapture-api.md) · [All operations](https://skmtc.net/geocapture/apis/geocapture-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/geocapture/geocapture-api/versions/15839b24c497/schema)