List campaigns

1 of 13 fields has no description in the spec.

• limit#numberin query

  The max number of items to return.

• cursor#stringin query

  The id of the last item from the previous page. Used to fetch the next page.

• givingType_in#string[]in queryat least 1 items

  FINANCIALPAYROLLPAID_TIME_OFF

• type#stringin query

  Filter on campaign type

  TIME_BASEDPERMANENT

• status#stringin query

  Filter on campaign status

  DRAFTPENDINGACTIVECOMPLETECANCELED

• includeMetrics#booleanin query

  Include metrics

• includeMatchedDonationsInMetrics#booleanin query

  Include matched donations made by and charged to the beneficiary in the metrics

• includeSiteUrl#booleanin query

  Include site url

• includeAssets#booleanin query

  Include assets such as the QR code linking to the campaign page for a public campaign.

• includeTranslations#booleanin query

  Include available translations if any for every localized fields.

• accountId#stringin queryUUID

  Id of the account. Only useful for Platform customers to filter campaigns by child accounts.

• search#stringin queryat least 3 characters

  Full text search on the name field. Minimum length: 3

  Required in the spec, optional for the API.

• sort#stringin query

  Sorting field and order

  createdAt:asccreatedAt:descname:ascname:descstatus:ascstatus:descmetrics.claimedDonationsVolume:ascmetrics.claimedDonationsVolume:desc

No field is described in the spec.

• campaignId#stringalways returned

• name#stringalways returned

• type#CampaignType

  TIME_BASEDPERMANENT

• amountType#CampaignAmountType

  FIXED_AMOUNTFREE_AMOUNT

• audienceType#CampaignAudienceType

  PRIVATEPUBLIC

• donationType#CampaignDonationType

  FACE_VALUEDISTRIBUTION

• givingType#GivingTypealways returned

  FINANCIALPAYROLLPAID_TIME_OFF

• recurringType#RecurringTypealways returned

  NONEFREQUENCYMANUAL

• startDate#string (date-time)always returned

• endDate#string (date-time)

• budget#integer (int64)

• sendingMode#CampaignSendingMode

  MANUALEMAILPHYSICALSLACKPOSTAL

• status#CampaignStatus

  DRAFTPENDINGACTIVECOMPLETECANCELED

• slug#string

• publicKey#stringalways returned

• withFiscalReceipts#booleanalways returned

• language#Language

  fren

• frequency#string

• budgetFrequency#string

• billingStatus#BillingStatusalways returned

  PENDINGBILLEDPAID

• defaultHideAmount#boolean

• withHideAmountCustomization#boolean

• withGiftCards#boolean

• withLeadCollection#boolean

• withoutCustomization#booleanalways returned

• momentType#MomentType

  OCCASIONKEY_MOMENTEDITION

• momentSlug#string

• leadCollectionOptions#object

• donationsBilledOn#DonationBilledOnalways returned

  CREATIONCLAIM

• withDonationsValidation#booleanalways returned

• fiscalReceiptType#FiscalReceiptTypealways returned

  YEARLYSINGLE_DONATION

• fiscalReceiptSendingMode#FiscalReceiptSendingModealways returned

  MANUALEMAIL

• defaultHasBeenCharged#booleanalways returned

• defaultFeeType#FeeTypealways returned

  EXCLUDEDINCLUDED

• donationValidityPeriod#stringalways returned

• template#string

• physicalFormat#PhysicalFormat

  CUSTOMPRINTPARCEL

• withEmailWall#boolean

• postDonationWidgets#PostDonationWidget[]always returned

• title#string

• description#string

• logoUrl#string

• faviconUrl#string

• titleColor#string

• accentColor#string

• givingTarget#integer (int64)

• message#string

• reminderMessage#string

• emailSenderName#string

• emailSenderPictureUrl#string

• emailSubject#string

• emailTemplate#string

• emailReplyTo#string

• emailDisplayCard#boolean

• lastCustomerReminderId#string

• charitiesSelectionId#string

• accountId#stringalways returned

• campaignTemplateId#string

• donorPlatformId#string

• createdAt#string (date-time)always returned

• updatedAt#string (date-time)always returned

Errors

• 400A field is missing, has the wrong type, or is not part of the request schema.

  Every request with a body or query is validated.

  {
    "statusCode": 400,
    "message": [
      "amount must not be less than 1",
      "property foo should not exist"
    ],
    "error": "Bad Request"
  }

• 401Unauthorized

  Missing, expired or invalid access token.

  {
    "statusCode": 401,
    "message": "Unauthorized"
  }

• 403Account closed

  {
    "message": "Account closed",
    "code": "ACCOUNT_CLOSED"
  }