List custom links: Migration guide

This guide outlines the changes introduced in the List custom links v2 endpoint (previously known as GET getCustomLinks in v1).

💡

Key changes

• Pagination: The v2 endpoint is paginated with a page size of 1,000 custom links. A Link header is provided in the response to fetch subsequent pages.

Documentation links

Here are the links to the API reference for:

• API v1
• API v2

Endpoint mapping

Here's the direct correlation between the v1 and v2 endpoint URLs:

• API v1: /api/v1/customlinks
• API v2: /api/v2/custom-links

Input changes

This section details the specific alterations to the input requirements between API versions.

API v1 input example

curl --location -g 'https://app.360learning.com/api/v1/customlinks?company={{company}}&apiKey={{apiKey}}'

API v2 input example

curl --request GET \
     --url https://app.360learning.com/api/v2/custom-links \
     --header '360-api-version: v2.0' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer access_token'

Main input differences

Output changes

This section details the specific alterations to the successful output returned between API versions.

API v1 output example

[
  {
    "_id": "62824f79aeu0e6fedb8b9255",
    "company": "5c376013c7bd33220c4c28ad",
    "name": "Gmail",
    "order": 0,
    "type": "mailbox link",
    "iconName": "inbox"
  }
]

API v2 output example

[
  {
    "name": "Gmail",
    "order": 0,
    "type": "mailbox link",
    "iconName": "inbox",
    "_id": "62824f79aeu0e6fedb8b9255"
  }
]

Main output differences

API v2 introduces pagination.