Retrieves a Campaign resource.

GET

/api/campaigns/{id}

GET

/api/campaigns/{id}

curl -X GET "/api/campaigns/{id}" \
  -H "apikey: $MEDIALISTER_API_KEY"

Authorization

apikey
string
header
required
Value for the apikey header parameter.

Parameters

id
string
path
required
Campaign identifier

Response

application/ld+json

Campaign resource

@context
one of
@id
string
required
@type
string
required
id
string<uuid>
name
string
required
defaultProject
string
goal
string
required
goalDetails
string
domain
string | null
budget
enum<integer> | null
One of:
0
1
2
3
4
publishingPeriod
enum<integer> | null
One of:
0
1
3
2
4
regions
any[]
notificationsCount
integer
Default:
0
totalOrderCount
integer
Default:
0
createdAt
string<date-time>
updatedAt
string<date-time>
onBoarding
Onboarding.jsonld-campaign.read_all.read | null
locationsList
map of GeoLocation.jsonld-campaign.read_all.read

{
  "@context": "string",
  "@id": "string",
  "@type": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Campaign Name",
  "defaultProject": "/api/default_projects/uuid",
  "goal": "My Goal",
  "goalDetails": "seo-in-new-articles",
  "domain": "string",
  "budget": 0,
  "publishingPeriod": 0,
  "regions": [
    "dXJuOm1ieHBsYzpSRUk",
    "dXJuOm1ieHBsYzpSRUd"
  ],
  "notificationsCount": 0,
  "totalOrderCount": 0,
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z",
  "onBoarding": {
    "@context": "string",
    "@id": "string",
    "@type": "string",
    "textSubmittedOn": "2026-01-15T09:30:00Z",
    "textReviewedOn": "2026-01-15T09:30:00Z",
    "textPublishedOn": "2026-01-15T09:30:00Z",
    "isOrderMade": false,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdAt": "2026-01-15T09:30:00Z",
    "updatedAt": "2026-01-15T09:30:00Z"
  },
  "locationsList": {
    "key": {
      "@context": "string",
      "@id": "string",
      "@type": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "providerId": "string",
      "type": 0,
      "placeName": "London",
      "code": "string",
      "showFirst": false,
      "priority": 0,
      "createdAt": "2026-01-15T09:30:00Z",
      "updatedAt": "2026-01-15T09:30:00Z",
      "stripeVerificationSupported": true,
      "typeDisplay": 0
    }
  }
}

{ "@context": "string", "@id": "string", "@type": "string", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "Campaign Name", "defaultProject": "/api/default_projects/uuid", "goal": "My Goal", "goalDetails": "seo-in-new-articles", "domain": "string", "budget": 0, "publishingPeriod": 0, "regions": [ "dXJuOm1ieHBsYzpSRUk", "dXJuOm1ieHBsYzpSRUd" ], "notificationsCount": 0, "totalOrderCount": 0, "createdAt": "2026-01-15T09:30:00Z", "updatedAt": "2026-01-15T09:30:00Z", "onBoarding": { "@context": "string", "@id": "string", "@type": "string", "textSubmittedOn": "2026-01-15T09:30:00Z", "textReviewedOn": "2026-01-15T09:30:00Z", "textPublishedOn": "2026-01-15T09:30:00Z", "isOrderMade": false, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdAt": "2026-01-15T09:30:00Z", "updatedAt": "2026-01-15T09:30:00Z" }, "locationsList": { "key": { "@context": "string", "@id": "string", "@type": "string", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "providerId": "string", "type": 0, "placeName": "London", "code": "string", "showFirst": false, "priority": 0, "createdAt": "2026-01-15T09:30:00Z", "updatedAt": "2026-01-15T09:30:00Z", "stripeVerificationSupported": true, "typeDisplay": 0 } } }