GET v3/lists/{listId}/subscribers
https://api.questline.com/v3/lists/{listId}/subscribers
Gets a list of list subscribers; relationships between a list and subscribers.
Request Information
URI Parameters
| Name | Description | Type | Additional Info |
|---|---|---|---|
| listId | globally unique identifier | Required |
Body Parameters
None.
Filters
| Name | Description | Usage |
|---|---|---|
| created | Filters the request by created date. | GET v3/lists/{listId}/subscribers?filter=created~{operator}~{value} |
Sorting
| Name | Description | Usage |
|---|---|---|
| created | Sorts the request by created date. | GET v3/lists/{listId}/subscribers?sort=created~{direction} |
Paging
| Name | Description | Usage |
|---|---|---|
| index | The index to retrieve when requesting paged results. | GET v3/lists/{listId}/subscribers?page=index~{value} |
| size | The size of the page when requesting paged results. | GET v3/lists/{listId}/subscribers?page=size~{value} |
Response Information
Resource Description
GetListSubscribersResponseV3| Name | Description | Type | Additional Info |
|---|---|---|---|
| ListSubscribers | The list of list subscribers. | Collection of ListSubscriberV3 | None. |
| NextPageUrl | The URL of the next page of data for the list. | string | None. |
| PageIndex | The index of the requested page. | integer | None. |
| PageSize | The size of the requested page. | integer | None. |
| TotalPages | The total number of pages, based on total results and page size. | integer | None. |
| TotalResults | The total number of results. | integer | None. |
| Error | The response error, if any. | ResponseErrorV3 | None. |
Response Formats
application/json, text/json
Sample:
{
"ListSubscribers": [
{
"ListId": "0a57616f-fe6f-4b7c-a2c4-b571e7de65d7",
"SubscriberId": "c6676098-e189-45ab-89a7-b8b685a43145",
"Created": "2024-04-25T04:38:25.1443612+00:00"
},
{
"ListId": "0a57616f-fe6f-4b7c-a2c4-b571e7de65d7",
"SubscriberId": "c6676098-e189-45ab-89a7-b8b685a43145",
"Created": "2024-04-25T04:38:25.1443612+00:00"
}
],
"NextPageUrl": "sample string 1",
"PageIndex": 1,
"PageSize": 1,
"TotalPages": 1,
"TotalResults": 1,
"Error": {
"ErrorId": 1,
"ErrorMessage": "sample string 1"
}
}
text/javascript, application/javascript, application/json-p
Sample:
/**/ typeof === 'function' && ({"ListSubscribers":[{"ListId":"0a57616f-fe6f-4b7c-a2c4-b571e7de65d7","SubscriberId":"c6676098-e189-45ab-89a7-b8b685a43145","Created":"2024-04-25T04:38:25.1443612+00:00"},{"ListId":"0a57616f-fe6f-4b7c-a2c4-b571e7de65d7","SubscriberId":"c6676098-e189-45ab-89a7-b8b685a43145","Created":"2024-04-25T04:38:25.1443612+00:00"}],"NextPageUrl":"sample string 1","PageIndex":1,"PageSize":1,"TotalPages":1,"TotalResults":1,"Error":{"ErrorId":1,"ErrorMessage":"sample string 1"}});