GET v3/lists

https://api.questline.com/v3/lists

Gets a list of lists.

Request Information

URI Parameters

None.

Body Parameters

None.

Filters

Name Description Usage
created Filters the request by created date. GET v3/lists?filter=created~{operator}~{value}
name Filters the request by name. GET v3/lists?filter=name~{operator}~{value}
subscriberCount Filters the request by subscriber count. GET v3/lists?filter=subscribercount~{operator}~{value}

Sorting

Name Description Usage
created Sorts the request by created date. GET v3/lists?sort=created~{direction}
name Sorts the request by name. GET v3/lists?sort=name~{direction}
subscriberCount Sorts the request by subscriber count. GET v3/lists?sort=subscribercount~{direction}

Paging

Name Description Usage
index The index to retrieve when requesting paged results. GET v3/lists?page=index~{value}
size The size of the page when requesting paged results. GET v3/lists?page=size~{value}

Response Information

Resource Description

GetListsResponseV3
Name Description Type Additional Info
Lists The list of lists. Collection of ListV3 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:

{
  "Lists": [
    {
      "Created": "2025-01-18T05:08:49.4770549+00:00",
      "ListId": "b9e3e545-6236-42b0-a8d7-cf4df13b4bd7",
      "Name": "sample string 3",
      "SubscriberCount": 4
    },
    {
      "Created": "2025-01-18T05:08:49.4770549+00:00",
      "ListId": "b9e3e545-6236-42b0-a8d7-cf4df13b4bd7",
      "Name": "sample string 3",
      "SubscriberCount": 4
    }
  ],
  "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' && ({"Lists":[{"Created":"2025-01-18T05:08:49.4770549+00:00","ListId":"b9e3e545-6236-42b0-a8d7-cf4df13b4bd7","Name":"sample string 3","SubscriberCount":4},{"Created":"2025-01-18T05:08:49.4770549+00:00","ListId":"b9e3e545-6236-42b0-a8d7-cf4df13b4bd7","Name":"sample string 3","SubscriberCount":4}],"NextPageUrl":"sample string 1","PageIndex":1,"PageSize":1,"TotalPages":1,"TotalResults":1,"Error":{"ErrorId":1,"ErrorMessage":"sample string 1"}});