---
title: "Search Campaigns"
method: GET
path: "/campaign"
tags: ["campaign"]
---

# Search Campaigns

`GET /campaign`

Search all Campaigns this user has access to

## Query parameters

- `campaignId` integer
- `name` string
- `tags` string
- `hasLayouts` integer
- `isLayoutSpecific` integer
- `retired` integer
- `totalDuration` integer
- `embed` string
- `folderId` integer

## Response `200`

successful operation

- Campaign[]
  - `campaignId` integer — The Campaign Id
  - `ownerId` integer — The userId of the User that owns this Campaign
  - `campaign` string — The name of the Campaign
  - `isLayoutSpecific` integer — A 0|1 flag to indicate whether this is a Layout specific Campaign or not.
  - `numberLayouts` integer — The number of Layouts associated with this Campaign
  - `totalDuration` integer — The total duration of the campaign (sum of layout's durations)
  - `folderId` integer — The id of the Folder this Campaign belongs to
  - `permissionsFolderId` integer — The id of the Folder responsible for providing permissions for this Campaign

## Changes

- **2021-02-09** `9ddbdc81e86a` — 1 info
  - added the new optional `query` request parameter `folderId`
- **2020-02-17** `8e1275395104` — 1 breaking, 3 warning
  - removed the media type `application/json` for the response with the status `200`
  - deleted the `query` request parameter `exactTags`
  - deleted the `query` request parameter `folderId`
  - deleted the `query` request parameter `logicalOperator`

[Change history](https://skmtc.dev/xibosignage/apis/xibo-api/changes/campaign/get.md)

---

[API](https://skmtc.dev/xibosignage/apis/xibo-api.md) · [All operations](https://skmtc.dev/xibosignage/apis/xibo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xibosignage/apis/xibo-api/revisions/1d1d9ec919fa?raw)