Link List
This API retrieves a list of created short links.
Only links of the URL type can be retrieved.
Links of other types, such as post links, form links, and card links, are excluded.
This API is available from the Premium plan and above.
Http Header
GET /api/link/v1/list?regStartYmdt={regStartYmdt}®EndYmdt={regEndYmdt}&pages={pages}
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: -
User-agent: {Your User-agent}
Accept-Language: en
Request
{
"regStartYmdt": "2025-08-01 00:00:00",
"regEndYmdt": "2025-08-10 23:59:59",
"pages": 1
}| Fields | Field Descriptions | Description | Required | Type |
|---|---|---|---|---|
| linkId | Link ID | Search the list by link ID. URLEncode is required if the link ID contains special characters. | string | |
| domain | Domain | Search the list by link domain. The domain must be preceded by the value http:// or https://. | string | |
| createTypeIdx | Creation type idx | 0:All links, 270:Links created in the Vivoldi dashboard, 272:Links created via API call, 274:Bulk link generation | int | |
| grpIdx | Group ID | Retrieve the list by group ID. If there is no value, it is set to the default value of 0. | int | |
| url | Long URL | Search the list by long URL. Allows partial search of the URL address. | string | |
| ttl | Link Title | Search the list by the title of the link. You can partially search by title. | string | |
| brandLinkYn | Branded links | If the link ID is not automatically generated and is set manually, it is a branded link. Y: Enabled (branded link), N: Disabled (automatically generated link) | Y or N | |
| notfSubscYn | Push link | Y:Enabled, N:Disabled | Y or N | |
| pushNotifyYn | Clicks Push notifications | Y:Enabled, N:Disabled | Y or N | |
| mailNotifyYn | Clicks Mail notifications | Y:Enabled, N:Disabled | Y or N | |
| regStartYmdt | Creation start date | The start date when the link was created, which must fall between the start date and end date. Example: 2022-11-08 00:00:00 | Date | |
| regEndYmdt | Creation end date | The end date the link was created, which must fall between the start and end dates. Example: 2022-11-08 23:59:59 The end date must be set within one month of the start date. | Date | |
| pages | Pages | The pages value is used for pagination and defaults to 1. 한 페이지에 기본적으로 30개의 행이 조회되며 pages의 값이 2일 경우 By default, 30 rows are retrieved on a page, and if the value of PAGES is 2, 30 rows of data are retrieved starting from the 31st row. | int | |
| delYmd | Link removal date | After the set date, the link is automatically deleted by the system. If you set a value, data will be retrieved before the set date. Example: 2025-12-31 | Date |
Response
{
"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",
"delYmd": "",
"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",
"delYmd": "2025-12-31",
"regYmdt": "2022-11-07 17:10:22",
"modYmdt": "2022-11-07 17:10:22"
}
]
}
}| Fields | Description | Type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | Response code (0: Success) | int | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| message | Response message. If the response code is not 0, a related message will be returned. | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| result | extra (Additional Information)
list (Link List) - Array
| array |