---
title: "Fetch project list."
method: GET
path: "/project/fetch"
tags: ["Projects|Project"]
---

# Fetch project list.

`GET /project/fetch`

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.

## Query parameters

- `projects[byIds][]` integer[]
- `projects[byReferences][]` string[]
- `projects[byImportKeys][]` string[]
- `projects[importSource]` string
- `projects[byProjectCategoryIds][]` integer[]
- `offset` integer
- `limit` integer

## Response `200`

Success Response:

- StandardProjectFetchResponse
  - `data` object[] — The projects.
    - `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)
    - `orderReference` string — The order reference. (max. 255 characters)
    - `offerReference` string — The offer reference. (max. 255 characters)
    - `contactPerson` string — Contact person. (max. 255 characters)
    - `phoneNumber` string — Telephone number. (max. 255 characters)
    - `mobileNumber` string — Mobile number. (max. 255 characters)
    - `email` string — Email. (max. 255 characters)
    - `validFrom` string — Represents a date. (ISO 8601) ICU-Format: yyyy-MM-dd
    - `validTo` string — Represents a date. (ISO 8601) ICU-Format: yyyy-MM-dd
    - `resourcePlanningFrom` string — Represents a date. (ISO 8601) ICU-Format: yyyy-MM-dd
    - `resourcePlanningTo` string — Represents a date. (ISO 8601) ICU-Format: yyyy-MM-dd
    - `projectLeader` ApiHelperResponseProjectLeaderReference
      - `id` integer — The internal Project Leader ID. (EmployeeId or UserId)
      - `type` string — The internal Project Leader type. | Value | Description | | ----- | ----------- | | E | Project Leader type Employee | | U | Project Leader type User |
    - `category` StandardProjectCategoryBaseProjectCategoryListItem
      - `id` integer — The internal id of the project category.
      - `description` string — The description of the project category.
      - `externalId` string — The external ID of the project category.
      - `createdAt` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `fenceBounds` ComponentGeocodingLatLngBoundsInterface — Represents a rectangle in geo coordinates
      - `minLatLng` number[] — Represents a geo coordinate. An array of two double values, representing the latitude and longitude.
      - `maxLatLng` number[] — Represents a geo coordinate. An array of two double values, representing the latitude and longitude.
    - `fences` object[] — The project fences.
      - `type` string — Fence type. | Value | Description | |---------------|---------------------| | CIRCLE | Circle | | POLYGON | Polygon |
      - `bounds` ComponentGeocodingLatLngBoundsInterface — Represents a rectangle in geo coordinates
        - `minLatLng` number[] — Represents a geo coordinate. An array of two double values, representing the latitude and longitude.
        - `maxLatLng` number[] — Represents a geo coordinate. An array of two double values, representing the latitude and longitude.
      - `circleCenter` number[] — Represents a geo coordinate. An array of two double values, representing the latitude and longitude.
      - `circleRadius` integer — Circle radius in meters.
      - `polygonCoordinates` array[] — Polygon coordinates.
        - number[]
    - `fenceType` string — (Deprecated, use fences instead) Project fence type. | Value | Description | |---------------|---------------------| | RADIUS | Radius | | POLYGON | Polygon |
    - `fenceRadius` integer — (Deprecated, use fences instead) Project fence as radius. (In meters)
    - `fencePolygon` array[] — (Deprecated, use fences instead) Project fence as polygon.
      - number[]
    - `approvalRuleId` integer
    - `openingHours` DynamicWeekdayTime — Represents dynamic weekday times ~~~ JSON format: ~~~ {"MO":[["08:00","13:00"],["15:00","18:00"]],"WE":[["08:00","13:00"],["15:00","18:00"]],"FR":[["08:00","13:00"],["15:00","18:00"]]} ~~~
      - `MO` array[]
        - string[] — Represents dynamic weekday times
      - `TU` array[]
        - string[] — Represents dynamic weekday times
      - `WE` array[]
        - string[] — Represents dynamic weekday times
      - `TH` array[]
        - string[] — Represents dynamic weekday times
      - `FR` array[]
        - string[] — Represents dynamic weekday times
      - `SA` array[]
        - string[] — Represents dynamic weekday times
      - `SU` array[]
        - string[] — Represents dynamic weekday times
  - `offset` integer — Number of skiped records.
  - `totalCount` integer — Total number of available projects. (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)