---
title: "Gets the custom links."
method: GET
path: "/api/v1/admin/settings/customlinks"
tags: ["admin"]
---

# Gets the custom links.

`GET /api/v1/admin/settings/customlinks`

## Request

- The document declares no server URL.
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/kubermatic/apis/kubermatic-kubernetes-platform-api/docs/api/v1/admin/settings/customlinks/get.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

GlobalCustomLinks

- CustomLink[]: GlobalCustomLinks defines custom links for global settings
  - `icon` string
  - `label` string
  - `location` string
  - `url` string

## Other responses

- `401`: EmptyResponse is a empty response
- `403`: EmptyResponse is a empty response
- `default`: errorResponse

---

[API](https://skmtc.dev/kubermatic/apis/kubermatic-kubernetes-platform-api.md) - [All operations](https://skmtc.dev/kubermatic/apis/kubermatic-kubernetes-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kubermatic/apis/kubermatic-kubernetes-platform-api/revisions/815b9bf19db5?raw)
