Campaigns

List Campaigns

Changed on

Retrieve a list of campaigns.

Returns a paginated list of campaigns associated with the authenticated organization, filterable by various parameters.

get/print-mail/v1/campaigns

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/print-mail/v1/campaigns
  • Auth
    API key in header X-API-Key

Query parameters

skipinteger
limitinteger
string
OR
string

You can supply a structured search query instead of supplying unstructured text to any list endpoint help refine your search for a resource.

For example, let's say you created a series of letters that all had metadata: { campaignID: 'abc' }. You could search for all those letters by passing in { "metadata.campaignID": "abc" } into the search parameter.

Note that this string must be valid JSON.

You can supply any string to help narrow down the list of resources. For example, if you pass "New York" (quoted), it will return resources that have that string present somewhere in their response. Alternatively, you can supply a structured search query. See the documentation on StructuredSearchQuery for more details.

Response

A list object containing campaigns.

object'list' required
totalCountinteger required
skipinteger required
limitinteger required

Changes

  • 537d2bbc624aRevision changes
    • breaking

      added subschema #1 to the //////////// response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the //////////// response property anyOf list for the response status

  • afd5935c2b2cRevision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added to the /////// response property allOf list for the response status

    • info

      removed from the /////// response property allOf list for the response status