Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-06130577659.7 KB
Documents|File

Fetch file list.

Files in geoCapture are used in different areas of the application. They can be added to employees, vehicles, projects, orders and tools. This endpoint allows you to list uploaded and added files in geoCapture. Not included in this endpoint are custom forms. Please use the Custom Form endpoints for interacting with them. Also, miamapo maps are not included. mimapo is a tool for creating sketches on maps. For more information, please click on this link: <a href="https://miamapo.de/" target="_blank">miamapo</a>

If you want to download a file, you must use the fetch_file endpoint.

get/file/fetch

Query parameters

filter[byIds][]integer[]

Filters the file based on the internal IDs.

filter[byExternalIds][]string[]

Filters the file based on the external IDs.

filter[byTypeId][]integer[]

Filters the file based on the file type id.

filter[byTypeReferences][]string[]

Filters the file based on the file type reference.

filter[ownerType]string

Filters the file based on the object type it is attached to. (required if ownerId is provided)

VEHICLE, ORDER, PROJECT, TOOL or EMPLOYEE

filter[ownerId]integer

Filters the file based on the object id it is attached to. (required if ownerType is provided)

filter[from]string
Example:2022-12-22

Filters the file based on the given date.

filter[to]string
Example:2022-12-22

Filters the file based on the given date.

offsetinteger

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

limitinteger

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

Response

Success Response:

offsetinteger

Number of skipped records.

totalCountinteger

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

Example response

{
  "data": [
    {
      "date": "2015-02-20",
      "validTo": "2015-02-20"
    }
  ]
}