v1

latestOpenAPI 3.0.02026-08-04265791.1 MB

Campaigns

Get

Get a campaign for the given id.

get/public/api/campaigns/{id}

Path parameters

idstring required

The id of the campaign

Headers

Acceptstring

e.g. application/json

Response

campaign_idstring

created_datestring

updated_datestring

titlestring

descriptionstring

tagsstring[]

typestring

page_titlesstring[]

activeboolean

Example response

{
  "campaign_id": "54ab03c6546847ee0d30086a",
  "created_date": "2018-05-23T04:51:40.862Z",
  "updated_date": "2018-05-23T04:51:40.862Z",
  "title": "Rockets campaign 1",
  "description": "campaign description here",
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "mission",
  "page_titles": [
    "Page 1"
  ],
  "active": true,
  "questions": [
    {
      "question_id": "e8335f8d-109d-475f-b10b-113ce6876dc7",
      "question_type": "number",
      "question": "number of ice-cream flavors",
      "page_number": 1,
      "question_number": 1
    },
    {
      "question_id": "e8335f8d-109d-475f-b10b-113ce6876dc8",
      "question_type": "text",
      "question": "ice-cream flavors",
      "page_number": 1,
      "question_number": 2
    }
  ]
}