---
title: "List custom links"
method: GET
path: "/api/v2/custom-links"
tags: ["Custom Links"]
---

# List custom links

`GET /api/v2/custom-links`

> 🔑
>
> Required OAuth scope: `customLinks:read`.

> 📖
>
> This endpoint is paginated with a page size of 1,000 custom links. For more information, see the [Pagination guide](https://360learning.readme.io/docs/pagination).

Lists all custom links.

## Headers

- `360-api-version` 'v2.0', required

## Response `200`

Returns one page of 1000 custom links.

- CustomLinkDTO[]
  - `name` string, required — The title displayed on the custom link.
  - `order` integer, required — The numeric display order (ascending). Links are arranged horizontally from left to right and wrap to the next line as needed.
  - `type` string, required — The unique identifier associated to your custom link. This information is not displayed to learners on the platform.
  - `iconName` 'agenda' | 'absence' | 'certificate' | 'convention' | 'default' | 'inbox' | 'survey' — The type of icon used on the custom link. By default, the link icon will be used.
  - `_id` string, ObjectId, required — The ID of the custom link.

## Other responses

- `401` — The given access token is either missing, invalid, has expired, or has been revoked.
- `403` — The given access token does not have the required OAuth scope to execute the request.
- `429` — The client has sent too many requests in a short amount of time.

---

[API](https://skmtc.net/360learning/apis/core-api.md) · [All operations](https://skmtc.net/360learning/apis/core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/360learning/core-api/revisions/94b691b0b72c/schema)