Overview
Read all seed lists for an account. The MID and partner appId are used from authentication. The View user permission is required.
Response
| 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. |
Validation Failure Scenarios
| HTTP Status | Description |
|---|---|
| 429 | API rate limit throttling is preventing success. |
Usage
Example Request
GET /messaging/v1/email/seed-lists
Example Responses
Data exists:
200 OK
{
"count": 3,
"page": 1,
"pageSize": 50,
"links": {
"self": {
"href": "/v1/email/seed-lists"
}
"items":[
{
"id": "fb9a8b12-a088-4999-b9ce-f8cd3fe06386",
"name": "seedList1Name1",
"description": "A description of seedList1Name1",
"activeSeedCount": 20
},
{
"id": "3b379c49-c01a-4fb4-a5dc-13a63c735c1d",
"name": "seedList1Name2",
"description": "some description2",
"activeSeedCount": 2
},
{
"id": "20e173cd-12aa-45e5-bd1f-b425730f39c6",
"name": "seedList1Name2",
"description": "some description2",
"activeSeedCount": 0
}
]
}
No data exists:
200 OK
{}