---
title: "List Aliases"
method: GET
path: "/api/admin/aliases"
tags: ["admin-aliases", "admin-aliases"]
---

# List Aliases

`GET /api/admin/aliases`

## Request

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

## Query parameters

- `q` string, nullable
- `limit` integer
- `offset` integer

## Response `200`

Successful Response

- AliasListResponse
  - `aliases` AliasRow[], required
    - `id` integer, required
    - `alias_text` string, required
    - `canonical_port_id` integer, required
    - `reason` string, nullable
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, nullable
    - `created_by` integer, nullable
    - `canonical_name` string, nullable
    - `country_iso2` string, nullable
    - `routable` boolean, nullable
    - `canonical_missing` boolean
  - `total` integer, required

## 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)