Sign in
Campaigns

List Campaigns

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

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

Changed in 3 of the 7 revisions of this API.1711

  • 537d2bbc624a11See the full diff
    • ▲

      added BinaryFile subschema #1 to the data/items/letter/allOf[CampaignLetterFields]/attachedPDF/allOf[AttachedPDF]/file response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      removed subschema #1 subschema #2 from the data/items/letter/allOf[CampaignLetterFields]/attachedPDF/allOf[AttachedPDF]/file response property anyOf list for the response status 200

      response-property-any-of-removed

  • afd5935c2b2c3See the full diff
    • ○

      added the optional property data/items/letter/allOf[CampaignLetterFields]/paper to the response with the 200 status

      response-optional-property-added

    • ○

      added PostcardPremiumPaperID to the data/items/postcard/allOf[CampaignPostcardFields]/paper response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed PremiumPaperID from the data/items/postcard/allOf[CampaignPostcardFields]/paper response property allOf list for the response status 200

      response-property-all-of-removed

  • c8fedcbd705e77See the full diff
    • ●

      removed the optional property data/items/chequeProfile from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/letterProfile from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/postcardProfile from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/selfMailerProfile from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new internal_server_error enum value to the error/type response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new rate_limit_exceeded_error enum value to the error/type response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new validation_error enum value to the error/type response property for the response status 400

      response-property-enum-value-added

    • ○

      added subschema #1 subschema #2 to the response body anyOf list for the response status 401

      response-body-any-of-added

    • ○

      removed subschema #1 subschema #2 from the response body anyOf list for the response status 401

      response-body-any-of-removed

    • ○

      added the optional property data/items/cheque to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/letter to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/postcard to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/selfMailer to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/snapPack to the response with the 200 status

      response-optional-property-added

    This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog