v1

latestOpenAPI 3.0.0Proprietary2026-08-06130577659.7 KB

Projects|Project

Fetch project list.

This endpoint enables you to obtain a project list, including details such as project address and geo-coordinates.

In geoCapture, projects are defined as designated sites or locations, including construction sites, company branches, or service areas. These areas are used to complete a variety of tasks and activities. Each project is defined by a unique location, on a map with an address or What3Words address, and has boundaries (either circular or polygonal) for accurate GPS tracking. All information captured within these limits, including time worked, assigned duties, or machinery operation, is automatically linked to the relevant project, enabling accurate supervision and record-keeping of on-site activities.

A maximum of 500 projects can be fetched at the same time.

get/project/fetch

Query parameters

projects[byIds][]integer[]

Filters based on the internal project IDs

projects[byReferences][]string[]

Filters based on the project numbers.

projects[byImportKeys][]string[]

Filters based on the external project IDs.

projects[importSource]string

Name of the external data source. (Default is "*API")

This parameter is only required if the external project ID is filtered.

projects[byProjectCategoryIds][]integer[]

Filters projects based on the category ids.

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 default value and max set at 500 records. This Parameter is optional.

Response

Success Response:

offsetinteger

Number of skiped records.

totalCountinteger

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

Example response

{
  "data": [
    {
      "latLng": [
        52.38127828631681,
        7.594243214018696
      ],
      "validFrom": "2015-02-20",
      "validTo": "2015-02-20",
      "resourcePlanningFrom": "2015-02-20",
      "resourcePlanningTo": "2015-02-20",
      "category": {
        "createdAt": "2015-02-20T12:59:21+01:00"
      },
      "fenceBounds": {
        "minLatLng": [
          52.38127828631681,
          7.594243214018696
        ],
        "maxLatLng": [
          52.38127828631681,
          7.594243214018696
        ]
      },
      "fences": [
        {
          "bounds": {
            "minLatLng": [
              52.38127828631681,
              7.594243214018696
            ],
            "maxLatLng": [
              52.38127828631681,
              7.594243214018696
            ]
          },
          "circleCenter": [
            52.38127828631681,
            7.594243214018696
          ],
          "polygonCoordinates": [
            [
              52.38127828631681,
              7.594243214018696
            ]
          ]
        }
      ],
      "fencePolygon": [
        [
          52.38127828631681,
          7.594243214018696
        ]
      ],
      "openingHours": {
        "MO": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "TU": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "WE": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "TH": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "FR": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "SA": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "SU": [
          [
            "08:00",
            "13:00"
          ]
        ]
      }
    }
  ]
}