GET v3/subscriptions

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

Gets a list of subscriptions.

Request Information

URI Parameters

None.

Body Parameters

None.

Sorting

Name Description Usage
modified Sorts the request by modified date. GET v3/subscriptions?sort=modified~{direction}
name Sorts the request by name. GET v3/subscriptions?sort=name~{direction}

Paging

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

Response Information

Resource Description

GetSubscriptionsResponseV3
Name Description Type Additional Info
Subscriptions The list of subscriptions. Collection of SubscriptionV3 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:

{
  "Subscriptions": [
    {
      "Created": "2024-04-19T20:07:18.2062546+00:00",
      "Modified": "2024-04-19T20:07:18.2062546+00:00",
      "Name": "sample string 3",
      "SubscriptionId": "11ef1385-18bb-4356-8976-25549c8ea416"
    },
    {
      "Created": "2024-04-19T20:07:18.2062546+00:00",
      "Modified": "2024-04-19T20:07:18.2062546+00:00",
      "Name": "sample string 3",
      "SubscriptionId": "11ef1385-18bb-4356-8976-25549c8ea416"
    }
  ],
  "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' && ({"Subscriptions":[{"Created":"2024-04-19T20:07:18.2062546+00:00","Modified":"2024-04-19T20:07:18.2062546+00:00","Name":"sample string 3","SubscriptionId":"11ef1385-18bb-4356-8976-25549c8ea416"},{"Created":"2024-04-19T20:07:18.2062546+00:00","Modified":"2024-04-19T20:07:18.2062546+00:00","Name":"sample string 3","SubscriptionId":"11ef1385-18bb-4356-8976-25549c8ea416"}],"NextPageUrl":"sample string 1","PageIndex":1,"PageSize":1,"TotalPages":1,"TotalResults":1,"Error":{"ErrorId":1,"ErrorMessage":"sample string 1"}});