GET v3/standardcampaigns

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

Gets a list of standard campaigns.

Request Information

URI Parameters

None.

Body Parameters

None.

Expands

Name Description Usage
sends Retrieves the related sends. GET v3/standardcampaigns?expand=sends

Filters

Name Description Usage
created Filters the request by created date. GET v3/standardcampaigns?filter=created~{operator}~{value}
hasEmail Filters the request by the has email flag. GET v3/standardcampaigns?filter=hasemail~{operator}~{value}
hasFax Filters the request by the has fax flag. GET v3/standardcampaigns?filter=hasfax~{operator}~{value}
hasSms Filters the request by the has SMS flag. GET v3/standardcampaigns?filter=hassms~{operator}~{value}
name Filters the request by name. GET v3/standardcampaigns?filter=name~{operator}~{value}

Sorting

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

Paging

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

Response Information

Resource Description

GetStandardCampaignsResponseV3
Name Description Type Additional Info
StandardCampaigns The list of standard campaigns. Collection of StandardCampaignV3 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:

{
  "StandardCampaigns": [
    {
      "StandardCampaignId": "b10be0bd-fd59-4f19-814d-002c7d75927a",
      "Created": "2025-01-18T05:19:02.5862163+00:00",
      "HasEmail": true,
      "HasFax": true,
      "HasSms": true,
      "Name": "sample string 5",
      "Sends": [
        {
          "StandardCampaignSendId": "f44a7a49-37b4-4d20-8d05-423d1924dfeb",
          "StandardCampaignId": "306d1095-d763-4070-a36c-1e9c00fb21df",
          "HasEmail": true,
          "HasFax": true,
          "HasSms": true,
          "Name": "sample string 5",
          "SendDate": "2025-01-18T05:19:02.5862163+00:00",
          "Status": "sample string 4",
          "SubjectLine": "sample string 8"
        },
        {
          "StandardCampaignSendId": "f44a7a49-37b4-4d20-8d05-423d1924dfeb",
          "StandardCampaignId": "306d1095-d763-4070-a36c-1e9c00fb21df",
          "HasEmail": true,
          "HasFax": true,
          "HasSms": true,
          "Name": "sample string 5",
          "SendDate": "2025-01-18T05:19:02.5862163+00:00",
          "Status": "sample string 4",
          "SubjectLine": "sample string 8"
        }
      ]
    },
    {
      "StandardCampaignId": "b10be0bd-fd59-4f19-814d-002c7d75927a",
      "Created": "2025-01-18T05:19:02.5862163+00:00",
      "HasEmail": true,
      "HasFax": true,
      "HasSms": true,
      "Name": "sample string 5",
      "Sends": [
        {
          "StandardCampaignSendId": "f44a7a49-37b4-4d20-8d05-423d1924dfeb",
          "StandardCampaignId": "306d1095-d763-4070-a36c-1e9c00fb21df",
          "HasEmail": true,
          "HasFax": true,
          "HasSms": true,
          "Name": "sample string 5",
          "SendDate": "2025-01-18T05:19:02.5862163+00:00",
          "Status": "sample string 4",
          "SubjectLine": "sample string 8"
        },
        {
          "StandardCampaignSendId": "f44a7a49-37b4-4d20-8d05-423d1924dfeb",
          "StandardCampaignId": "306d1095-d763-4070-a36c-1e9c00fb21df",
          "HasEmail": true,
          "HasFax": true,
          "HasSms": true,
          "Name": "sample string 5",
          "SendDate": "2025-01-18T05:19:02.5862163+00:00",
          "Status": "sample string 4",
          "SubjectLine": "sample string 8"
        }
      ]
    }
  ],
  "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' && ({"StandardCampaigns":[{"StandardCampaignId":"b10be0bd-fd59-4f19-814d-002c7d75927a","Created":"2025-01-18T05:19:02.5862163+00:00","HasEmail":true,"HasFax":true,"HasSms":true,"Name":"sample string 5","Sends":[{"StandardCampaignSendId":"f44a7a49-37b4-4d20-8d05-423d1924dfeb","StandardCampaignId":"306d1095-d763-4070-a36c-1e9c00fb21df","HasEmail":true,"HasFax":true,"HasSms":true,"Name":"sample string 5","SendDate":"2025-01-18T05:19:02.5862163+00:00","Status":"sample string 4","SubjectLine":"sample string 8"},{"StandardCampaignSendId":"f44a7a49-37b4-4d20-8d05-423d1924dfeb","StandardCampaignId":"306d1095-d763-4070-a36c-1e9c00fb21df","HasEmail":true,"HasFax":true,"HasSms":true,"Name":"sample string 5","SendDate":"2025-01-18T05:19:02.5862163+00:00","Status":"sample string 4","SubjectLine":"sample string 8"}]},{"StandardCampaignId":"b10be0bd-fd59-4f19-814d-002c7d75927a","Created":"2025-01-18T05:19:02.5862163+00:00","HasEmail":true,"HasFax":true,"HasSms":true,"Name":"sample string 5","Sends":[{"StandardCampaignSendId":"f44a7a49-37b4-4d20-8d05-423d1924dfeb","StandardCampaignId":"306d1095-d763-4070-a36c-1e9c00fb21df","HasEmail":true,"HasFax":true,"HasSms":true,"Name":"sample string 5","SendDate":"2025-01-18T05:19:02.5862163+00:00","Status":"sample string 4","SubjectLine":"sample string 8"},{"StandardCampaignSendId":"f44a7a49-37b4-4d20-8d05-423d1924dfeb","StandardCampaignId":"306d1095-d763-4070-a36c-1e9c00fb21df","HasEmail":true,"HasFax":true,"HasSms":true,"Name":"sample string 5","SendDate":"2025-01-18T05:19:02.5862163+00:00","Status":"sample string 4","SubjectLine":"sample string 8"}]}],"NextPageUrl":"sample string 1","PageIndex":1,"PageSize":1,"TotalPages":1,"TotalResults":1,"Error":{"ErrorId":1,"ErrorMessage":"sample string 1"}});