Sign in
Campaigns

Get All

Get all the campaigns.

get/public/api/campaigns?filter={filter}

Query parameters

filterstring

A valid JSON filter object

Headers

Acceptstring

e.g. application/json

Request body

Example request

{
  "Authorization": {
    "Authorization": "Bearer JWT"
  }
}

Response

OK

campaign_idstring required
created_datestring required
updated_datestring required
titlestring required
descriptionstring required
tagsstring[] required
typestring required
page_titlesstring[] required
icon_urlstring required
background_urlstring required

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"
    ],
    "icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1569401814/ji2yhtw926naemtsj6xr.png",
    "background_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1569401827/seuuqjbry1e4uusi0nta.png",
    "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
      }
    ]
  },
  {
    "campaign_id": "54ab03c6546847ee0d30086b",
    "created_date": "2018-05-23T04:51:40.862Z",
    "updated_date": "2018-05-23T04:51:40.862Z",
    "title": "Rockets campaign 2",
    "description": "campaign description here",
    "tags": [
      "tag1",
      "tag3"
    ],
    "type": "mission",
    "page_titles": [
      "Page 1"
    ],
    "icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1569401814/ji2yhtw926naemtsj6xr.png",
    "background_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1569401827/seuuqjbry1e4uusi0nta.png",
    "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": "do you prefer sorbet?",
        "page_number": 2,
        "question_number": 1
      }
    ]
  }
]

Changes

No recorded changes to this endpoint across all 5 revisions of this API.