GET
/
admin
/
campaigns
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.campaign.list()
.then(({ campaigns, count, limit, offset }) => {
  console.log(campaigns)
})
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "campaigns": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "currency": "<string>",
      "campaign_identifier": "<string>",
      "starts_at": "<string>",
      "ends_at": "<string>",
      "budget": {
        "id": "<string>",
        "type": "spend",
        "currency_code": "<string>",
        "limit": 123,
        "used": 123
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

​
offset
number

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

OK

The paginated list of campaigns. The list of campaigns

​
limit
number
required

The maximum number of items retrieved.

​
offset
number
required

The number of its skipped before the returned items.

​
count
number
required

The total number of items.

​
campaigns
object[]
required

The list of campaigns.