Link Group List

API to retrieve the list of link groups.

Returns all link group information created by the user.
To assign a specific group when creating a link, use this API to retrieve the group list or check it in the dashboard.

GET

/api/link-group/v1/list?nm={nm}

{
    "nm": "My+group"
}

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": [
        {
            "idx":1,
            "nm":"Amazon Electronics",
            "memo":"Products between $100 and $500",
            "linkCnt":112,
            "blockOverseasSticsYn":"N",
            "notfSubscYn":"N",
            "kakaoNotifyYn":"N",
            "pushNotifyYn":"N",
            "mailNotifyYn":"N",
            "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",
            "kakaoNotifyYn":"N",
            "pushNotifyYn":"Y",
            "mailNotifyYn":"N",
            "regYmdt":"2024-07-20 02:42:00",
            "modYmdt":"2025-02-12 11:20:50"
        }
    ]
}

Response Parameters

codeinteger
Response code: 0 = Success, any other value = Error
messagestring
Response message. If the response code is not 0, an error-related message is returned.
resultarray
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.
pushNotifyYnstring
Whether push notifications for clicks are enabled.
mailNotifyYnstring
Whether email notifications for clicks are enabled.
regYmdtdatetime
Creation date.
modYmdtdatetime
Modification date.