Link List

API to retrieve the list of generated short links.

This API is available only on Premium plans or higher.

GET

/api/link/v1/list?regStartYmdt={regStartYmdt}&regEndYmdt={regEndYmdt}&pages={pages} 

{
    "regStartYmdt": "2025-09-01 00:00:00",
    "regEndYmdt": "2025-09-10 23:59:59",
    "pages": 1
}

Request Parameters

regStartYmdtdatetimerequired
Link creation date (Start). Specifies the start date for the query.
Example: 2025-09-01 00:00:00
regEndYmdtdatetimerequired
Link creation date (End). Specifies the end date for the query.
Example: 2025-09-10 23:59:59
pagesintegerrequired
Page number. Default value is 1.
Each page returns 30 results by default. For example, if pages=2, results are returned from the 31st record.
linkIdstring
Link ID.
domainstring
Link domain.
createTypeIdxinteger
Link creation method.
0: All links, 270: Created via dashboard, 272: Created via API, 274: Created via Excel upload.
grpIdxinteger
Link group.
urlstring
Original URL. Please provide the full URL starting with “https://”.
Partial URL searches are not supported.
ttlstring
Link title. Partial search is supported.
If spaces or Unicode characters are included, URL Encoding is recommended.
brandLinkYnstring
Whether it is a brand link.
memostring
Note for link management. Partial search is supported.
If spaces or Unicode characters are included, URL Encoding is recommended.
notfSubscYnstring
Whether it is a push subscription link.
qrBypassYn string
Default:N
Enum:
YN
Controls whether to skip the short URL when scanning a QR code and directly access the original URL specified by the user.
Y: Redirects directly to the original URL without passing through the short URL. (QR scan statistics not recorded)
N: Passes through the short URL before redirecting to the original URL. (QR scan statistics recorded)
pushNotifyYnstring
Whether push notifications for clicks are enabled.
mailNotifyYnstring
Whether email notifications for clicks are enabled.
startDelYmdt datetime
Link deletion start datetime.
endDelYmdt datetime
Link deletion end datetime. 
{
    "code": 0,
    "message": "",
    "result": {
        "extra": {
            "pages": 1,
            "nextPages": 1,
            "nextYn": "N",
            "count": 2,
            "totalCount": 2
        },
        "list": [
            {
                "linkId": "createpostinglinks",
                "domain": "https://vvd.im",
                "typeIdx": 103,
                "typeNm": "URL",
                "redirectType": 302,
                "ttl": "Add YouTube videos using post links to create short links",
                "description": "",
                "metaImg": "",
                "memo": "",
                "url": "https://vvd.im/createpostinglinks",
                "grpIdx": 0,
                "grpNm": "",
                "acesCnt": 5072,
                "acesCntToday": 315,
                "acesMaxCnt": 0,
                "pernCnt": 4958,
                "lastClkYmdt": "2022-11-07 04:45:10",
                "longUrl": "https://vivoldi.com/blog/url-shortener/create-posts-link-url-shortener",
                "blockOverseasSticsYn": "N",
                "notfSubscYn": "N",
                "qrBypassYn": "N",
                "pushNotifyYn": "N",
                "mailNotifyYn": "N",
                "strtYmdt": "",
                "endYmdt": "",
                "expireUrl": "",
                "pwd": "",
                "nonmemberSticsPwd": "",
                "webhookEnableYn": "N",
                "webhookMetric": "C",
                "webhookFrequency": 1,
                "delYmdt": "",
                "regYmdt": "2022-11-02 04:27:05",
                "modYmdt": "2022-11-02 04:27:05"
            },
            {
                "linkId": "4Rth",
                "domain": "https://vvd.bz",
                "typeIdx": 103,
                "typeNm": "URL",
                "redirectType": 200,
                "description": "Discover diverse information and useful content on Naver's main page.",
                "metaImg": "https://s.pstatic.net/static/www/mobile/edit/2016/0705/mobile_212852414260.png",
                "ttl": "NAVER",
                "memo": "",
                "url": "https://vvd.bz/4Rth",
                "grpIdx": 128,
                "grpNm": "Test",
                "acesCnt": 19,
                "acesCntToday": 3,
                "acesMaxCnt": 1000,
                "pernCnt": 16,
                "lastClkYmdt": "2022-11-07 17:20:40",
                "longUrl": "https://www.naver.com",
                "blockOverseasSticsYn": "N",
                "notfSubscYn": "N",
                "qrBypassYn": "Y",
                "pushNotifyYn": "Y",
                "mailNotifyYn": "N",
                "strtYmdt": "2025-09-01 00:00:00",
                "endYmdt": "2025-09-30 23:59:59",
                "expireUrl": "https://yourdomain.com/event/closed.html",
                "pwd": "",
                "nonmemberSticsPwd": "123456",
                "webhookEnableYn": "Y",
                "webhookMetric": "C",
                "webhookFrequency": 1,
                "delYmdt": "2025-12-31 23:59:59",
                "regYmdt": "2022-11-07 17:10:22",
                "modYmdt": "2022-11-07 17:10:22"
            }
        ]
    }
}

Response Parameters

code integer
Response code: 0 = Success, other values = Error
message string
Response message. If the response code is not 0, an error message is returned.
result object
extra object
Page and data count information.
pages integer
Current page number
nextPages integer
Next page number
nextYn string
Whether there is a next page
count integer
Number of records on the current page
totalCount integer
Total number of records
list array
Link Information
linkId string
Link ID.
domain string
Domain.
typeIdx integer
Default:103
Enum:
103104106107108119447
Link type (IDX). 103: URL, 104: Post, 106: Deep Link, 107: Button, 108: Card, 119: QR, 447: Form.
typeNm string
Link type (Name).
redirectType integer
Default:302
Enum:
200301302
Redirect type.
See Terminology for details.
This feature is available on Personal plans and above.
ttl string
Link title.
description string
When redirectType is 200, the description meta tag can be set.
metaImg string
When redirectType is 200, the image meta tag can be set.
Image URLs must start with https://.
memo string
Note for link management.
linkId string
Link ID.
url string
Short URL.
grpIdx integer
Link group (IDX).
grpNm string
Link group (Name).
acesCnt integer
Total clicks.
acesCntToday integer
Clicks today.
acesMaxCnt integer
Maximum allowed click count.
pernCnt integer
Number of unique users (Unique Clicks).
lastClkYmdt datetime
Last click date.
longUrl string
Original URL.
notfSubscYn string
Default:N
Enum:
YN
Whether it is a push subscription link.
qrBypassYn string
Default:N
Enum:
YN
Controls whether to skip the short URL when scanning a QR code and directly access the original URL specified by the user.
Y: Redirects directly to the original URL without passing through the short URL. (QR scan statistics not recorded)
N: Passes through the short URL before redirecting to the original URL. (QR scan statistics recorded)
pushNotifyYn string
Default:N
Enum:
YN
Whether push notifications for clicks are enabled.
mailNotifyYn string
Default:N
Enum:
YN
Whether email notifications for clicks are enabled.
strtYmdt datetime
Start date and time of validity period.
endYmdt datetime
End date and time of validity period.
expireUrl string
URL to redirect to after expiration.
pwd string
Link access password.
Required when accessing the link.
nonmemberSticsPwd string
Link statistics password.
Required to view click and analytics data. Share only with authorized users.
webhookEnableYn string
Enum:
YN
Whether the Webhook is enabled.
webhookMetric string
Enum:
CP
Webhook receiving metric.
C: Based on click count, P: Based on unique users.
webhookFrequency integer
Enum:
1501002003005001000
Webhook receiving frequency.
1: Every click, 50: Every 50 clicks, 100: Every 100 clicks, 300: Every 300 clicks, 500: Every 500 clicks, 1000: Every 1,000 clicks.
delYmdt datetime
Scheduled deletion date of the link.
regYmdt datetime
Created date.
modYmdt datetime
Modified date.