Link Group List API (v2)

Retrieve a list of link groups via API.

Filter by group IDX or name, and get the required grpIdx for link create, update, and delete operations.

GET

/api/link-group/v2/list?nm={nm}&pages={pages} 


GET /api/link-group/v2/list
     ?nm=My+group
     &pages=1

Request Parameters

grpIdxinteger
Link group (IDX).
nmstring
Link group (Name). Partial search is supported.
If spaces or Unicode characters are included, URL Encoding is recommended. 
{
    "code": 0,
    "message": "",
    "result": {
        "extra": {
            "pages": 1,
            "nextPages": 1,
            "nextYn": "N",
            "count": 2,
            "totalCount": 2
        },
        "list": [
            {
                "idx":1,
                "nm":"Amazon Electronics",
                "memo":"Products between $100 and $500",
                "linkCnt":112,
                "blockOverseasSticsYn":"N",
                "notfSubscYn":"N",
                "pushNotifyYn":"N",
                "mailNotifyYn":"N",
                "webhookEnableYn": "Y",
                "webhookCallbackUrl": "https://yourdomain.com/webhook/callback/vivoldi",
                "webhookMetric": "P",
                "webhookFrequency": 1,
                "regYmdt":"2024-07-20 02:30:00",
                "modYmdt":"2024-08-15 17:45:10"
            },
            {
                "idx":2,
                "nm":"XXX Advertiser Group",
                "memo":"2-year contract",
                "linkCnt":68,
                "blockOverseasSticsYn":"N",
                "notfSubscYn":"Y",
                "qrBypassYn":"N",
                "pushNotifyYn":"Y",
                "mailNotifyYn":"N",
                "webhookEnableYn": "N",
                "webhookCallbackUrl": null,
                "webhookMetric": "C",
                "webhookFrequency": 1,
                "regYmdt":"2024-07-20 02:42:00",
                "modYmdt":"2025-02-12 11:20:50"
            }
        ]
    }
}

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
Group Information
idxinteger
Group IDX.
nmstring
Group name.
memostring
Memo for group management.
linkCntinteger
Number of links in the group.
notfSubscYnstring
Whether it is a push subscription link.
qrBypassYn string
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.
webhookEnableYn string
Enum:
YN
Whether to enable Webhook.
webhookCallbackUrl string
Webhook Callback URL.
webhookMetric string
Enum:
CP
Webhook receiving metric.
C: Based on click count, P: Based on unique users (unique clicks).
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.
regYmdtdatetime
Creation date.
modYmdtdatetime
Modification date.

When to Use This API

Use this API when you need a group ID (grpIdx) for link creation or updates.

It’s useful when the dashboard is not accessible or when automation scripts need to fetch group IDs dynamically.

Load all groups to build dropdown UIs or search specific groups to check their status.
Beyond simple retrieval, it often serves as the starting point of your link management workflow.

Filtering tips

Pass grpIdx to retrieve a specific group.
The nm parameter supports partial search, so entering part of the group name returns matching results.

If the name contains spaces or Unicode characters, apply URL encoding to ensure accurate results.

Response structure and usage

이 API는 페이지 기반 구조화된 데이터를 반환합니다.
조회 결과는 단순 출력이 아니라 후속 API와 연결되는 기준 데이터로 사용됩니다.

페이지 정보 (extra)

  • pages → 현재 페이지
  • nextPages → 다음 페이지 존재 여부
  • count → 현재 페이지 데이터 수
  • totalCount → 전체 그룹 수

대량 데이터 처리 시 반복 조회 로직 구성 기준이 됩니다.

설정 정보 포함 구조

응답에는 그룹의 운영 설정도 함께 포함됩니다.

예:

  • 접근 제어 (notSubscYn, qrBypassYn)
  • 알림 (pushNotifyYn, mailNotifyYn)
  • Webhook (webhookEnableYn, webhookCallbackUrl)
  • totalCount → 전체 그룹 수

별도 조회 없이 현재 상태를 즉시 파악 가능합니다.

Use cases

  • Automation pipelines: Retrieve the group list before creating links to obtain grpIdx
  • Group management UI: Load all groups and render them as dropdown options
  • Search specific groups: Enter part of the group name in nm to quickly filter matching groups
  • Pagination handling: Increment pages sequentially to iterate through all groups

Things to consider

  • If the nm parameter contains spaces or Unicode characters, apply URL encoding.
    Otherwise, search results may be inaccurate.
  • pages represents the page number and starts from 1.
    If nextYn is N, it indicates the last page, so you can stop iterating.
  • The idx value in the response is identical to grpIdx used in link create, update, and delete APIs.
    Be careful not to confuse them.