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

# List links

`GET /links`

List the links of the company paginated by id. Allows filtering by link type via the q.types param.
These links include application objects; for more details, see the [Links](https://dev.frontapp.com/reference/links) topic.


Required scope: `links:read`

## Query parameters

- `q` string
- `limit` integer
- `page_token` string
- `sort_by` string
- `sort_order` 'asc' | 'desc'

## Response `200`

Array of Links

- object
  - `_pagination` object
    - `next` string, nullable — Link to next [page of results](https://dev.frontapp.com/docs/pagination)
  - `_links` object
    - `self` string — Link to resource
  - `_results` LinkResponse[]
    - `_links` object, required
      - `self` string — Link to resource
    - `id` string, required — Unique identifier of the link
    - `name` string, required — Display name of the link
    - `type` string, required — Type of the link. Typically associated with the underlying link provider (if known)
    - `external_url` string, required — Underlying identifying external URL of the link
    - `custom_fields` CustomFieldParameter, required — An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields

---

[API](https://skmtc.net/frontapp/apis/core-api.md) · [All operations](https://skmtc.net/frontapp/apis/core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/frontapp/core-api/versions/76d1eaa2d0eb/schema)