Campaign JSON Schema

To request a collection of campaigns use the URL path "/campaigns.json".

To request a single campaign use the URL path "/campaigns/< permalink >.json.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Campaign",
  "description": "A campaign object from REACH",
  "type": "object",
  "properties": {
    "title": {
      "description": "Returns the title of the campaign.",
      "type": "string"
    },
    "permalink": {
      "description": "Returns the permalink of the campaign.",
      "type": "string"
    },
    "url": {
      "description": "Returns the relative URL of the campaign.",
      "type": "string"
    },
    "full_url": {
      "description": " Returns the full URL with domain name of the campaign.",
      "type": "string"
    },
    "short_description": {
      "description": "Returns the short description of the campaign.",
      "type": "string"
    },
    "long_description": {
      "description": "Returns the description of the campaign.",
      "type": "string"
    },
    "approved": {
      "description": "Returns a true/false value for whether the campaign is approved.",
      "type": "boolean"
    },
    "goal_amount": {
      "description": "Returns the amount the campaign is trying to raise.",
      "type": "number"
    },
    "total": {
      "description": "Returns the total amount raised for the campaign.",
      "type": "number"
    },
    "goal_end_date": {
      "description": "Returns the end date of the campaign.",
      "type": "date"
    },
    "video_link": {
      "description": "Returns the YouTube or Vimeo video link of the campaign.",
      "type": "string"
    },
    "images": {
      "type": "object",
      "items": {
        "thumbnail": "string",
        "small": "string",
        "medium": "string",
        "large": "string",
        "original": "string"
      }
    },
    "cover_images": {
      "type": "object",
      "items": {
        "cover": "string",
        "original": "string"
      }
    }
  }
}

Feedback and Knowledge Base