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}®EndYmdt={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. Partial search is 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.
- blockOverseasSticsYnstring
- Whether overseas statistics are blocked.
- pushNotifyYnstring
- Whether push notifications for clicks are enabled.
- mailNotifyYnstring
- Whether email notifications for clicks are enabled.
- startDelYmdtdatetime
- Link deletion start datetime.
- endDelYmdtdatetime
- 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",
"ttl": "Add YouTube videos using post links to create short links",
"memo": "",
"url": "https://vvd.im/createpostinglinks",
"grpIdx": 0,
"grpNm": "",
"acesCnt": 5072,
"acesCntToday": 315,
"lastClkYmdt": "2022-11-07 04:45:10",
"longUrl": "https://vivoldi.com/blog/url-shortener/create-posts-link-url-shortener",
"blockOverseasSticsYn": "N",
"notfSubscYn": "N",
"kakaoNotifyYn": "N",
"pushNotifyYn": "N",
"mailNotifyYn": "N",
"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",
"ttl": "NAVER",
"memo": "",
"url": "https://vvd.bz/4Rth",
"grpIdx": 128,
"grpNm": "Test",
"acesCnt": 19,
"acesCntToday": 3,
"lastClkYmdt": "2022-11-07 17:20:40",
"longUrl": "https://www.naver.com",
"blockOverseasSticsYn": "N",
"notfSubscYn": "N",
"kakaoNotifyYn": "N",
"pushNotifyYn": "Y",
"mailNotifyYn": "N",
"delYmdt": "2025-12-31 23:59:59",
"regYmdt": "2022-11-07 17:10:22",
"modYmdt": "2022-11-07 17:10:22"
}
]
}
}
Response Parameters
- codeinteger
- Response code: 0 = Success, other values = Error
- messagestring
- Response message. If the response code is not 0, an error message is returned.
- resultobject
- extraobject
- Page and data count information.
- pagesinteger
- Current page number
- nextPagesinteger
- Next page number
- nextYnstring
- Whether there is a next page
- countinteger
- Number of records on the current page
- totalCountinteger
- Total number of records
- listarray
- Link Information
- linkIdstring
- Link ID.
- domainstring
- Domain.
- typeIdxinteger
- Default:103
- Enum:103104106107108119447
- Link type (IDX). 103: URL, 104: Post, 106: Deep Link, 107: Button, 108: Card, 119: QR, 447: Form.
- typeNmstring
- Link type (Name).
- ttlstring
- Link title.
- memostring
- Note for link management.
- linkIdstring
- Link ID.
- urlstring
- Short URL.
- grpIdxinteger
- Link group (IDX).
- grpNmstring
- Link group (Name).
- acesCntinteger
- Total clicks.
- acesCntTodayinteger
- Clicks today.
- lastClkYmdtdatetime
- Last click date.
- longUrlstring
- Original URL.
- notfSubscYnstring
- Default:N
- Enum:YN
- Whether it is a push subscription link.
- blockOverseasSticsYnstring
- Default:N
- Enum:YN
- Whether overseas statistics are blocked.
- pushNotifyYnstring
- Default:N
- Enum:YN
- Whether push notifications for clicks are enabled.
- mailNotifyYnstring
- Default:N
- Enum:YN
- Whether email notifications for clicks are enabled.
- delYmdtdatetime
- Scheduled deletion date of the link.
- regYmdtdatetime
- Created date.
- modYmdtdatetime
- Modified date.