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

# Query campaigns

`GET /campaigns`

Query campaigns

## Response `200`

Successful response

- QueryCampaignsResponse, nullable
  - `campaigns` Campaign[], required
    - `attachments` Attachment[], required
      - `actions` Action[]
        - `name` string, required
        - `style` string
        - `text` string, required
        - `type` string, required
        - `value` string
      - `asset_url` string
      - `author_icon` string
      - `author_link` string
      - `author_name` string
      - `color` string
      - `fallback` string
      - `fields` Field[]
        - `short` boolean, required
        - `title` string, required
        - `value` string, required
      - `footer` string
      - `footer_icon` string
      - `giphy` Images
        - `fixed_height` ImageData, required
          - `frames` string, required
          - `height` string, required
          - `size` string, required
          - `url` string, required
          - `width` string, required
        - `fixed_height_downsampled` ImageData, required
          - `frames` string, required
          - `height` string, required
          - `size` string, required
          - `url` string, required
          - `width` string, required
        - `fixed_height_still` ImageData, required
          - `frames` string, required
          - `height` string, required
          - `size` string, required
          - `url` string, required
          - `width` string, required
        - `fixed_width` ImageData, required
          - `frames` string, required
          - `height` string, required
          - `size` string, required
          - `url` string, required
          - `width` string, required
        - `fixed_width_downsampled` ImageData, required
          - `frames` string, required
          - `height` string, required
          - `size` string, required
          - `url` string, required
          - `width` string, required
        - `fixed_width_still` ImageData, required
          - `frames` string, required
          - `height` string, required
          - `size` string, required
          - `url` string, required
          - `width` string, required
        - `original` ImageData, required
          - `frames` string, required
          - `height` string, required
          - `size` string, required
          - `url` string, required
          - `width` string, required
      - `image_url` string
      - `og_scrape_url` string
      - `original_height` number
      - `original_width` number
      - `pretext` string
      - `text` string
      - `thumb_url` string
      - `title` string
      - `title_link` string
      - `type` string — Attachment type (e.g. image, video, url)
    - `channel_type` string, required
    - `completed_at` string, date-time
    - `created_at` string, date-time, required
    - `defaults` object, required
    - `description` string, required
    - `details` string
    - `errored_messages` number
    - `failed_at` string, date-time
    - `id` string, required
    - `name` string, required
    - `resumed_at` string, date-time
    - `scheduled_at` string, date-time
    - `scheduled_for` string, date-time
    - `segment_id` string, required
    - `sender_id` string, required
    - `sent_messages` number
    - `status` string
    - `stopped_at` string, date-time
    - `task_id` string
    - `text` string, required
    - `updated_at` string, date-time, required
  - `channels` object, required
  - `duration` string, required — Duration of the request in human-readable format
  - `segments` object, required
  - `users` object, required

## Other responses

- `400` — Bad request
- `429` — Too many requests

---

[API](https://skmtc.net/streamioapi/apis/stream-io-api.md) · [All operations](https://skmtc.net/streamioapi/apis/stream-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/streamioapi/stream-io-api/versions/f5553620777b/schema)