---
title: "Retrieves the collection of Campaign resources."
method: GET
path: "/campaigns"
tags: ["Campaign"]
---

# Retrieves the collection of Campaign resources.

`GET /campaigns`

## Request

- Base URL: `https://example.myintranetapps.com/api`
- URL: `https://example.myintranetapps.com/api/campaigns`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/bossinsights/apis/boss-insights/docs/campaigns/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the collection of Campaign resources.

## Query parameters

- `page` integer
- `itemsPerPage` integer

## Response `200`

Campaign collection

- Campaign[]
  - `id` string
  - `integration` string: The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string: the unique identifier of the source 3rd party integration
  - `campaignName` string, nullable: name of the campaign
  - `campaignOwner` string, nullable: name of the person the campaign responsibility is assigned to
  - `description` string, nullable: details about the campaign
  - `startDate` string, date-time, nullable: campaign start time date
  - `endDate` string, date-time, nullable: campaign end time date
  - `budgetedCost` string, nullable: planned amount to spent on the campaign
  - `actualCost` string, nullable: actual amount spent on the campaign
  - `expectedRevenue` string, nullable: expected revenue from the campaign
  - `status` string, nullable: status of the campaign e.g:done
  - `created` string, date-time, nullable: when the campaign is created
  - `modified` string, date-time, nullable: when the campaign attributes is modified
  - `nExpectedResponse` integer, nullable

---

[API](https://skmtc.dev/bossinsights/apis/boss-insights.md) - [All operations](https://skmtc.dev/bossinsights/apis/boss-insights/llms.txt) - [OpenAPI document](https://skmtc.dev/bossinsights/apis/boss-insights/revisions/d08a107895ad?raw)