---
title: "List all links"
method: GET
path: "/external-links"
tags: ["External Links"]
---

# List all links

`GET /external-links`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/external-links`
- Auth: none declared

Returns all links.

## Query parameters

- `multiContains` IapLinksQuery: This is the schema for queries on IAP external links
  - `name` string
  - `address` string
  - `description` string
- `multiEquals` IapLinksQuery: This is the schema for queries on IAP external links
  - `name` string
  - `address` string
  - `description` string
- `multiStartsWith` IapLinksQuery: This is the schema for queries on IAP external links
  - `name` string
  - `address` string
  - `description` string
- `skip` integer: Number of results to skip. Used for pagination.
- `limit` integer: Number of results to return. Used for pagination.
- `sort` 'name': Field to sort by. Default is name.
- `order` '-1' | '1': The sort direction: 1 for ascending or -1 for descending.

## Response `200`

The links matching the specified query.

- ExternalLinksGetLinksResponse200
  - `results` IapLinksSchema: This is the schema for an IAP external link stored in Mongo
    - `name` string, required
    - `address` string, required
    - `description` string
    - `_meta` IapLinksSchemaMeta
      - `created` string
      - `updated` string
  - `total` integer: The total number of documents

## Other responses

- `500`: Error response from API

## Changes

- **2026-10-31** `2095cc90e583`: 2 info
  - api tag `External Links` added
  - api tag `externalLinks` removed

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/external-links/get.md)

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)