v1

latestOpenAPI 3.0.0Proprietary2026-08-06130577659.7 KB
Documents|Form data

Fetch a list of media for the form data.

This endpoint allows you to fetch a list of media used in custom forms. You can filter the list of media e.g. to recieve a list of media from only a specific form definition. When no filter is specified, the response will contain all media from all custom forms up to a limit of 100 records. You are able to download the media with the mediaData endpoint.

get/custom_form_data/media

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.

ValueDescription
NEWNew form data
FILLEDAlready filled form data
REVIEWCheck form data
APPROVEDApproved by test distributor
COMPLETEDCompleted form data
RESETResetted form data
BOOKEDBooked 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

fieldNamestring

Fieldname of the form.

limitinteger

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

offsetinteger

Number of media data to be skipped.

Response

Success Response:

offsetinteger

Number of skipped records.

totalCountinteger

Total number of available media files.