Directories

Directories are groups of features that contain additional reference information about agents or tasks. For more information about directories, see the Directories section of the Administrator guide.

Getting the list of directories

You can get a list of directories with their data: ID, name, creation and update date and time, and a list of directory objects.

To get the list of directories and their objects, send a GET request to /v1/dictionaries with the limit parameter - the maximum number of directories in the response (from 1 to 100).

Request example:

curl --request GET \
   --url 'https://geoflow.2gis.ru/public/api/v1/dictionaries?limit=2' \
   --header 'Authorization: Bearer <token>'

Response example:

response.json

{
    "items": [
        {
            "id": "4596eb86-fd9d-442e-9304-d3c567db0f17",
            "name": "Transport type",
            "items": [
                {
                    "id": "faa298c1-9cde-4f6a-9424-c66deb626814",
                    "label": "Car",
                    "ordering": 0,
                    "created_at": "2026-09-03T12:03:16.487584Z",
                    "updated_at": "2026-09-03T12:03:16.487584Z"
                },
                {
                    "id": "fbae8d16-7382-4937-b0de-0814125fc5c1",
                    "label": "Bicycle",
                    "ordering": 1,
                    "created_at": "2026-09-03T12:03:16.487584Z",
                    "updated_at": "2026-09-03T12:03:16.487584Z"
                }
            ],
            "created_at": "2026-09-03T12:03:16.487584Z",
            "updated_at": "2026-09-03T12:03:16.487584Z"
        },
        {
            "id": "14407f90-e695-4857-b62e-d5c3c7540733",
            "name": "Delivery skills",
            "items": [
                {
                    "id": "dcbcc460-92b5-4e97-991c-153c83cd09a7",
                    "label": "Fragile",
                    "ordering": 0,
                    "created_at": "2026-09-03T11:54:59.634812Z",
                    "updated_at": "2026-09-03T11:54:59.634812Z"
                },
                {
                    "id": "bfbb64ea-450f-4684-ae74-39d53ce55502",
                    "label": "Documents",
                    "ordering": 1,
                    "created_at": "2026-09-03T11:54:59.634812Z",
                    "updated_at": "2026-09-03T11:54:59.634812Z"
                }
            ],
            "created_at": "2026-09-03T11:54:59.634812Z",
            "updated_at": "2026-09-03T11:54:59.634812Z"
        }
    ],
    "cursor": {}
}

Each object contains an ID, name, order in the list, creation and update date and time.