v1

latestOpenAPI 3.0.0Proprietary2026-08-06130577659.7 KB
Orders|Order category

Fetch order category list

In geoCapture, order categories classify various types of orders into separate groups according to their nature or purpose. This helps to efficiently manage various tasks, including deliveries, maintenance, installations, and inspections. By grouping all maintenance-related tasks together under one category, resources can be allocated more easily, and work can be scheduled more efficiently. This functionality optimizes the workflow by enabling users to swiftly discern and handle orders based on their corresponding categories. Additionally, orders belonging to a specific category may inherit certain aspects, including desired or undesired qualifications.

get/order_category/fetch

Query parameters

filter[byIds][]integer[]

Filters the order category based on the internal IDs.

filter[byName]string

Filters the order category based on the name.

offsetinteger

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

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.

Response

Success Response:

offsetinteger

Number of skipped records.

totalCountinteger

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

Example response

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