---
title: "Search the Polygon Library"
method: GET
path: "/api/admin/library/polygons"
tags: ["polygon-library"]
---

# Search the Polygon Library

`GET /api/admin/library/polygons`

## Request

- Base URL: `https://grandline.luzomi.com`
- URL: `https://grandline.luzomi.com/api/admin/library/polygons`
- Auth: none declared

## Query parameters

- `q` string, nullable: Free text over name, code, port, terminal, UN/LOCODE, country
- `polygon_type` string, nullable: hierarchy_level: COUNTRY|PORT|TERMINAL|BERTH|WAITING
- `family_ids` string, nullable: Comma-separated polygon_family_id list
- `sector_id` integer, nullable
- `port_id` integer, nullable: parent_polygon_id of a PORT
- `terminal_id` integer, nullable: parent_polygon_id of a TERMINAL
- `country` string, nullable: ISO2 or country name
- `status` string, nullable
- `is_shared` boolean, nullable: Waiting areas linked to >1 port
- `geometry_status` string, nullable
- `tag` string, nullable
- `code` string, nullable
- `unlocode` string, nullable
- `review_status` string, nullable
- `updated_from` string, date-time, nullable
- `updated_to` string, date-time, nullable
- `include_archived` boolean: Include is_enabled=false / archived rows
- `include_geometry` 'none' | 'simplified' | 'full': List responses omit geometry by default (spec §12.2)
- `bbox` string, nullable: minLon,minLat,maxLon,maxLat
- `sort_by` 'name' | 'modified_at' | 'created_at' | 'hierarchy_level' | 'area_sqkm'
- `sort_order` 'asc' | 'desc'
- `page` integer
- `page_size` integer

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/luzomi/apis/grandline-api.md) · [All operations](https://skmtc.dev/luzomi/apis/grandline-api/llms.txt) · [OpenAPI document](https://skmtc.dev/luzomi/apis/grandline-api/revisions/4ce06aea012b?raw)