GET v3/subscribers

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

Gets a list of subscribers.

Request Information

URI Parameters

None.

Body Parameters

None.

Expands

Name Description Usage
attributes Retrieves the related attributes. GET v3/subscribers?expand=attributes
subscriptions Retrieves the related subscriptions. GET v3/subscribers?expand=subscriptions

Filters

Name Description Usage
address Filters the request by address. GET v3/subscribers?filter=address~{operator}~{value}
attributeName Filters the request by attribute name. GET v3/subscribers?filter=attributename~{operator}~{value}
attributeValue Filters the request by attribute value. GET v3/subscribers?filter=attributevalue~{operator}~{value}
created Filters the request by created date. GET v3/subscribers?filter=created~{operator}~{value}
hasEmail Filters the request by the has email flag. GET v3/subscribers?filter=hasemail~{operator}~{value}
hasFax Filters the request by the has fax flag. GET v3/subscribers?filter=hasfax~{operator}~{value}
hasSms Filters the request by the has SMS flag. GET v3/subscribers?filter=hassms~{operator}~{value}
subscriberKey Filters the request by subscriber key. GET v3/subscribers?filter=subscriberkey~{operator}~{value}
suppressed Filters the request by suppressed flag. GET v3/subscribers?filter=suppressed~{operator}~{value}

Sorting

Name Description Usage
created Sorts the request by created date. GET v3/subscribers?sort=created~{direction}
lastName Sorts the request by last name. GET v3/subscribers?sort=lastname~{direction}

Paging

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

Response Information

Resource Description

GetSubscribersResponseV3
Name Description Type Additional Info
Subscribers The list of subscribers. Collection of SubscriberV3 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:

{
  "Subscribers": [
    {
      "Address": "sample string 1",
      "Attributes": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "Created": "2025-01-17T20:13:52.9736243+00:00",
      "FaxNumber": "sample string 3",
      "FirstName": "sample string 4",
      "HasEmail": true,
      "HasFax": true,
      "HasSms": true,
      "LastName": "sample string 8",
      "Modified": "2025-01-17T20:13:52.9736243+00:00",
      "SmsNumber": "sample string 10",
      "SubscriberId": "66564307-b273-4d1e-a2d8-0bd83e01062d",
      "SubscriberKey": "sample string 12",
      "Subscriptions": [
        {
          "Name": "sample string 1",
          "ReceiveEmail": true,
          "ReceiveFax": true,
          "ReceiveSms": true,
          "SubscriptionId": "690d474d-6bac-437f-aa4d-5e3510bd9fdb"
        },
        {
          "Name": "sample string 1",
          "ReceiveEmail": true,
          "ReceiveFax": true,
          "ReceiveSms": true,
          "SubscriptionId": "690d474d-6bac-437f-aa4d-5e3510bd9fdb"
        }
      ],
      "Suppressed": true,
      "AccountManager": "sample string 14",
      "AccountNumber": "sample string 15",
      "AddressLine1": "sample string 16",
      "AddressLine2": "sample string 17",
      "City": "sample string 18",
      "Company": "sample string 19",
      "State": "sample string 20",
      "ZipCode": "sample string 21",
      "PreferredContentTopics": "sample string 22",
      "PreferredMediaTypes": "sample string 23",
      "LanguagePreference": "sample string 24"
    },
    {
      "Address": "sample string 1",
      "Attributes": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "Created": "2025-01-17T20:13:52.9736243+00:00",
      "FaxNumber": "sample string 3",
      "FirstName": "sample string 4",
      "HasEmail": true,
      "HasFax": true,
      "HasSms": true,
      "LastName": "sample string 8",
      "Modified": "2025-01-17T20:13:52.9736243+00:00",
      "SmsNumber": "sample string 10",
      "SubscriberId": "66564307-b273-4d1e-a2d8-0bd83e01062d",
      "SubscriberKey": "sample string 12",
      "Subscriptions": [
        {
          "Name": "sample string 1",
          "ReceiveEmail": true,
          "ReceiveFax": true,
          "ReceiveSms": true,
          "SubscriptionId": "690d474d-6bac-437f-aa4d-5e3510bd9fdb"
        },
        {
          "Name": "sample string 1",
          "ReceiveEmail": true,
          "ReceiveFax": true,
          "ReceiveSms": true,
          "SubscriptionId": "690d474d-6bac-437f-aa4d-5e3510bd9fdb"
        }
      ],
      "Suppressed": true,
      "AccountManager": "sample string 14",
      "AccountNumber": "sample string 15",
      "AddressLine1": "sample string 16",
      "AddressLine2": "sample string 17",
      "City": "sample string 18",
      "Company": "sample string 19",
      "State": "sample string 20",
      "ZipCode": "sample string 21",
      "PreferredContentTopics": "sample string 22",
      "PreferredMediaTypes": "sample string 23",
      "LanguagePreference": "sample string 24"
    }
  ],
  "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' && ({"Subscribers":[{"Address":"sample string 1","Attributes":[{"Name":"sample string 1","Value":"sample string 2"},{"Name":"sample string 1","Value":"sample string 2"}],"Created":"2025-01-17T20:13:52.9736243+00:00","FaxNumber":"sample string 3","FirstName":"sample string 4","HasEmail":true,"HasFax":true,"HasSms":true,"LastName":"sample string 8","Modified":"2025-01-17T20:13:52.9736243+00:00","SmsNumber":"sample string 10","SubscriberId":"66564307-b273-4d1e-a2d8-0bd83e01062d","SubscriberKey":"sample string 12","Subscriptions":[{"Name":"sample string 1","ReceiveEmail":true,"ReceiveFax":true,"ReceiveSms":true,"SubscriptionId":"690d474d-6bac-437f-aa4d-5e3510bd9fdb"},{"Name":"sample string 1","ReceiveEmail":true,"ReceiveFax":true,"ReceiveSms":true,"SubscriptionId":"690d474d-6bac-437f-aa4d-5e3510bd9fdb"}],"Suppressed":true,"AccountManager":"sample string 14","AccountNumber":"sample string 15","AddressLine1":"sample string 16","AddressLine2":"sample string 17","City":"sample string 18","Company":"sample string 19","State":"sample string 20","ZipCode":"sample string 21","PreferredContentTopics":"sample string 22","PreferredMediaTypes":"sample string 23","LanguagePreference":"sample string 24"},{"Address":"sample string 1","Attributes":[{"Name":"sample string 1","Value":"sample string 2"},{"Name":"sample string 1","Value":"sample string 2"}],"Created":"2025-01-17T20:13:52.9736243+00:00","FaxNumber":"sample string 3","FirstName":"sample string 4","HasEmail":true,"HasFax":true,"HasSms":true,"LastName":"sample string 8","Modified":"2025-01-17T20:13:52.9736243+00:00","SmsNumber":"sample string 10","SubscriberId":"66564307-b273-4d1e-a2d8-0bd83e01062d","SubscriberKey":"sample string 12","Subscriptions":[{"Name":"sample string 1","ReceiveEmail":true,"ReceiveFax":true,"ReceiveSms":true,"SubscriptionId":"690d474d-6bac-437f-aa4d-5e3510bd9fdb"},{"Name":"sample string 1","ReceiveEmail":true,"ReceiveFax":true,"ReceiveSms":true,"SubscriptionId":"690d474d-6bac-437f-aa4d-5e3510bd9fdb"}],"Suppressed":true,"AccountManager":"sample string 14","AccountNumber":"sample string 15","AddressLine1":"sample string 16","AddressLine2":"sample string 17","City":"sample string 18","Company":"sample string 19","State":"sample string 20","ZipCode":"sample string 21","PreferredContentTopics":"sample string 22","PreferredMediaTypes":"sample string 23","LanguagePreference":"sample string 24"}],"NextPageUrl":"sample string 1","PageIndex":1,"PageSize":1,"TotalPages":1,"TotalResults":1,"Error":{"ErrorId":1,"ErrorMessage":"sample string 1"}});