Справочники

Справочники — это группы признаков, которые содержат дополнительную справочную информацию об агентах или задачах. Подробнее о справочниках см. в разделе Справочники Руководства администратора.

Получение списка справочников

Вы можете получить список справочников с данными о них: ID, названием, датой и временем создания и обновления, а также списком объектов справочника.

Чтобы получить список справочников и их объектов, отправьте GET-запрос к /v1/dictionaries с параметром limit — максимальным количеством справочников в ответе от 1 до 100.

Пример запроса:

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

Пример ответа:

response.json

{
    "items": [
        {
            "id": "4596eb86-fd9d-442e-9304-d3c567db0f17",
            "name": "Тип транспорта",
            "items": [
                {
                    "id": "faa298c1-9cde-4f6a-9424-c66deb626814",
                    "label": "Автомобиль",
                    "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": "Велосипед",
                    "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": "Навыки доставки",
            "items": [
                {
                    "id": "dcbcc460-92b5-4e97-991c-153c83cd09a7",
                    "label": "Хрупкое",
                    "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": "Документы",
                    "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": {}
}

Каждый объект содержит ID, название, порядок в списке, дату и время создания и обновления.