Admin

List all campaigns

Retrieve a list of all campaigns.

get/admin/campaigns

Request

  • Base URL: https://api.presscart.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.presscart.com/admin/campaigns
  • Auth: HTTP bearer

Query parameters

limitnumber nullable
pagenumber nullable
order_by'asc' | 'desc'
sort_bystring
include_archived'true' | 'false'
searchstring
profile_idstring uuid

Scope results to campaigns belonging to this profile.

Response

Campaigns retrieved successfully

total_pagesnumber required
current_pagenumber required
next_pagenumber nullable required
previous_pagenumber nullable required
total_recordsnumber required

Example response

{
  "records": [
    {
      "name": "Campaign A",
      "team": {
        "name": "Team A"
      },
      "articles": [
        {
          "name": "Stabilis amplus auctor advenio velum umerus cuius.",
          "writer": {
            "first_name": "Alfreda",
            "last_name": "Tremblay"
          },
          "status": [
            {
              "name": "Waiting for content brief",
              "prefix": "waiting-for-content-brief",
              "color": "red",
              "notes": "Soluta non umquam solio verto crapula pecus."
            }
          ],
          "order_item": {
            "name": "Blog Post"
          }
        }
      ],
      "questionnaire": {
        "objectives": "Demergo cui ducimus. Curo arto spiritus expedita quam. Odio decor texo absconditus celo molestiae sumptus."
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.