GET v3/subscribers/bykey/{subscriberKey}

https://api.questline.com/v3/subscribers/bykey/{subscriberKey}

Gets a subscriber.

Request Information

URI Parameters

Name Description Type Additional Info
subscriberKey The ID of the subscriber. string Required

Body Parameters

None.

Expands

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

Response Information

Resource Description

GetSubscriberResponseV3
Name Description Type Additional Info
Subscriber The subscriber. SubscriberV3 None.
Error The response error, if any. ResponseErrorV3 None.

Response Formats

application/json, text/json

Sample:

{
  "Subscriber": {
    "Address": "sample string 1",
    "Attributes": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "Created": "2025-01-18T05:01:33.0215962+00:00",
    "FaxNumber": "sample string 3",
    "FirstName": "sample string 4",
    "HasEmail": true,
    "HasFax": true,
    "HasSms": true,
    "LastName": "sample string 8",
    "Modified": "2025-01-18T05:01:33.0215962+00:00",
    "SmsNumber": "sample string 10",
    "SubscriberId": "14ffeba4-ea7f-46f0-9546-f164a0e3d9f1",
    "SubscriberKey": "sample string 12",
    "Subscriptions": [
      {
        "Name": "sample string 1",
        "ReceiveEmail": true,
        "ReceiveFax": true,
        "ReceiveSms": true,
        "SubscriptionId": "cd80e177-2776-4fd0-a53a-a62c7cfed772"
      },
      {
        "Name": "sample string 1",
        "ReceiveEmail": true,
        "ReceiveFax": true,
        "ReceiveSms": true,
        "SubscriptionId": "cd80e177-2776-4fd0-a53a-a62c7cfed772"
      }
    ],
    "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"
  },
  "Error": {
    "ErrorId": 1,
    "ErrorMessage": "sample string 1"
  }
}

text/javascript, application/javascript, application/json-p

Sample:

/**/ typeof  === 'function' && ({"Subscriber":{"Address":"sample string 1","Attributes":[{"Name":"sample string 1","Value":"sample string 2"},{"Name":"sample string 1","Value":"sample string 2"}],"Created":"2025-01-18T05:01:33.0215962+00:00","FaxNumber":"sample string 3","FirstName":"sample string 4","HasEmail":true,"HasFax":true,"HasSms":true,"LastName":"sample string 8","Modified":"2025-01-18T05:01:33.0215962+00:00","SmsNumber":"sample string 10","SubscriberId":"14ffeba4-ea7f-46f0-9546-f164a0e3d9f1","SubscriberKey":"sample string 12","Subscriptions":[{"Name":"sample string 1","ReceiveEmail":true,"ReceiveFax":true,"ReceiveSms":true,"SubscriptionId":"cd80e177-2776-4fd0-a53a-a62c7cfed772"},{"Name":"sample string 1","ReceiveEmail":true,"ReceiveFax":true,"ReceiveSms":true,"SubscriptionId":"cd80e177-2776-4fd0-a53a-a62c7cfed772"}],"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"},"Error":{"ErrorId":1,"ErrorMessage":"sample string 1"}});