Link Group List
The Link Group List API allows you to retrieve all link groups created by the user.
To assign a specific group when creating a link, first use this API to fetch the list and identify the desired group’s IDX value.
Including this IDX value in your link creation request will automatically apply the group’s settings to the new link, making management more efficient.
Http Header
GET /api/link-group/v1/list
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: -
User-agent: {Your User-agent}
Accept-Language: en
Request
{
"nm": "My group"
}| Fields | Field Descriptions | Description | Required | Type |
|---|---|---|---|---|
| grpIdx | Group IDX | Retrieves the group that exactly matches the specified group IDX. | int | |
| nm | Group Name | Searches for groups that contain the specified text in the group name. Partial matches are allowed; full name match is not required. | string |
Response
{
"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"
}
]
}| Fields | Description | Type | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | Response code (0: success) | int | ||||||||||||||||||||||||||||||||||||||||||||||||
| message | Included when the code is not 0. Contains an error message describing the reason for failure. | string | ||||||||||||||||||||||||||||||||||||||||||||||||
| result |
| array |