---
title: "List campaigns"
method: GET
path: "/campaigns"
tags: ["campaigns"]
---

# List campaigns

`GET /campaigns`

## Request

- Base URL: `https://api.lumahealth.io/api/v2`
- URL: `https://api.lumahealth.io/api/v2/campaigns`
- Auth: HTTP bearer

## Query parameters

- `ref` 'patient' | 'facility' | 'user'
- `refId` string
- `name` string
- `channels` string[]
- `active` boolean
- `lastUpdatedBy` 'patient' | 'integrator'
- `useRootAsFallback` boolean

## Response `200`

List of campaigns

- object
  - `response` Campaign[], required
    - `_id` string: Luma's internal ID of an object.
    - `user` string: The ID of the root account user.
    - `deleted` 0 | 1: Flag for logical deletion where 1 means deleted.
    - `createdBy` string: The ID of the user who created this object.
    - `updatedBy` string: The ID of the user who updated this object.
    - `createdAt` string, date-time: The date/time when this object was created.
    - `updatedAt` string, date-time: The date/time when this object was updated.
    - `ref` 'patient' | 'facility' | 'user'
    - `refId` string
    - `name` string
    - `channels` string[]
    - `type` 'inbound' | 'outbound'
    - `lastUpdatedBy` 'patient' | 'integrator'
    - `active` unknown
  - `page` integer, required
  - `size` integer, required

## Other responses

- `401`: Not authenticated
- `403`: Access token does not have the required scope

---

[API](https://skmtc.dev/lumahealth/apis/rest-service.md) - [All operations](https://skmtc.dev/lumahealth/apis/rest-service/llms.txt) - [OpenAPI document](https://skmtc.dev/lumahealth/apis/rest-service/revisions/f19aeba84a26?raw)