v1

latestOpenAPI 3.0.0Proprietary2026-08-06130577659.7 KB
Orders|Order

Fetch order list

geoCapture orders are detailed assignments created within the geoCapture system to manage and coordinate field operations such as service visits, maintenance tasks, or deliveries. Each order is a plan that includes important details like task descriptions, site locations, assigned staff, timelines, and specific activities, which ensure the accurate execution of field services.

These orders are crucial in geoCapture's tour planning. Efficient routes are created that optimize the itinerary of each field team for travel time, service duration, and client priorities. For instance, a geoCapture order might instruct a team to fit hardware at a new client's office. The order is then used to plot a route for the day, integrating other service calls along the way to reduce downtime and travel distance and, therefore, boost productivity whilst decreasing operational expenses. The order ensures that the team brings appropriate equipment and knowledge, resulting in a prosperous installation within the allotted timeframe.

get/order/fetch

Query parameters

filter[byIds][]integer[]

Filters the order based on the internal IDs.

filter[byExternalReferences][]string[]

Filters the order based on the customer order numbers.

filter[byTourIds][]integer[]

Filters the order based on the tour IDs.

filter[byStatusText]string

Filters the order based on the status text.

Value
ARRIVAL
ASSIGNED
CREATED
DEPARTURE
FINISHED
NEAREST_POSITION
OPENED_BY_USER
READ
REJECTED
SIGNED
STARTED
filter[byOrderType]string

Filters the order based on the order type.

Value
REPEAT
ORDER
SAVED
MACHINE_TRANSPORT
filter[byBounds]string
Example:52.37652038909364 7.605081948346127, 52.375099096475545 7.6082684126850175

Filters the order based on the given rectangle.

filter[byUnassigned]boolean

Filters the order based on whether it's assigned to a tour.

filter[byProjectIds][]integer[]

Filters the order based on the project IDs.

filter[byTeamIds][]integer[]

Filters the order based on the team 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 max and default value set at 500 records. This Parameter is optional.

Response

Success Response:

offsetinteger

Number of skipped records.

totalCountinteger

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

Example response

{
  "data": [
    {
      "createdAt": "2015-02-20T12:59:21+01:00"
    }
  ]
}