Retrieve collection of campaigns

get

/services/rest/connect/v1.4/campaigns

Request

Supported Media Types
Query Parameters
  • Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name
  • The requested page size, which limits the number of elements the collection should max return
  • The offset of the page. By default, offset is 0, which means first page will be returned.
  • Returns the count of elements as the given order. The value is a comma delimited string. Each token in the string is the name of the field, optionally followed by asc or desc.
  • Query parameter that allows searching by providing ROQL WHERE clause filtering
  • Indicates whether or not to calculate the totalResults property. By default, totalResults is not calculated.

Response

Supported Media Types

Default Response

Body ()
Collection of campaigns
Root Schema : campaigns-collection
Type: object
Collection of campaigns
Show Source

Examples

Use GET with the following syntax to list all campaigns:

https://your_site_interface/services/rest/connect/version/campaigns

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/campaigns

Response body example

{
  "items": [
    {
      "id": 1,
      "lookupName": "Campaign",
      "createdTime": "2008-04-18T16:09:51Z",
      "updatedTime": "2008-04-18T16:09:51Z",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/latest/campaigns/1"
        }
      ]
    },
    {
      "id": 2,
      "lookupName": "Campaign2",
      "createdTime": "2009-01-23T18:25:41Z",
      "updatedTime": "2009-02-05T18:20:32Z",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/latest/campaigns/2"
        }
      ]
    },

...

    {
      "id": 21,
      "lookupName": "Link Campaign",
      "createdTime": "2015-05-27T18:45:54Z",
      "updatedTime": "2015-05-27T19:15:29Z",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/latest/campaigns/21"
        }
      ]
    }
  ],
  "hasMore": false,
  "links": [
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/latest/campaigns"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/latest/metadata-catalog/campaigns",
      "mediaType": "application/schema+json"
    },
    {
      "rel": "search-form",
      "href": "https://mysite.example.com/services/rest/connect/latest/campaigns-search-form"
    },
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/latest/campaigns"
    }
  ]
}