Read all seed lists for an account. The MID and partner appId are used from authentication. The View user permission is required.
| Status | Name | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| 200 | Successful response indicating the request passed validations. | ||||||
| count | integer | The count of seed-lists. | |||||
| page | integer | The page number. | |||||
| pageSize | integer | The maximum of seed-lists allowed on a page under the current pagination settings. | |||||
| links | object | An object containing relevant links as name:value pairs, the values are objects. | |||||
| Name | Type | ||||||
| self | object | The name self is a default object name, with the nested object. | |||||
| Name | Type | ||||||
| href | string | The string value is the path of the calling url. | |||||
| items | list of objects | The container for the items. | |||||
| Name | Type | ||||||
| id | string | A globally unique identifier (GUID). | |||||
| name | string | The name of a seed-list, assigned at creation or update. | |||||
| description | string | The description of a seed-list, assigned at creation or update. | |||||
| activeSeedCount | integer | The count of seeds (email addresses) in the seed-list. | |||||
| 200 | Successful response but with an empty object, indicating no seed-lists for the partner appID. |
| HTTP Status | Description |
|---|---|
| 429 | API rate limit throttling is preventing success. |
1GET /messaging/v1/email/seed-listsData exists:
1200 OK
2{
3 "count": 3,
4 "page": 1,
5 "pageSize": 50,
6 "links": {
7 "self": {
8 "href": "/v1/email/seed-lists"
9 }
10 "items":[
11 {
12 "id": "fb9a8b12-a088-4999-b9ce-f8cd3fe06386",
13 "name": "seedList1Name1",
14 "description": "A description of seedList1Name1",
15 "activeSeedCount": 20
16 },
17 {
18 "id": "3b379c49-c01a-4fb4-a5dc-13a63c735c1d",
19 "name": "seedList1Name2",
20 "description": "some description2",
21 "activeSeedCount": 2
22 },
23 {
24 "id": "20e173cd-12aa-45e5-bd1f-b425730f39c6",
25 "name": "seedList1Name2",
26 "description": "some description2",
27 "activeSeedCount": 0
28 }
29 ]
30}No data exists:
1200 OK
2{}
j