---
title: "Get the publishing pause state"
method: GET
path: "/api/v1/publishing-pause"
tags: ["Publishing Pause"]
---

# Get the publishing pause state

`GET /api/v1/publishing-pause`

## Request

- Base URL: `https://www.poster.ly`
- URL: `https://www.poster.ly/api/v1/publishing-pause`
- Auth: HTTP bearer

Whether publishing is paused for the workspace, the paused brands the caller can see (a seat limited to some brands only sees those), and what the caller may do. Requires posts:read. Without workspace_id the key's workspace is used.

## Query parameters

- `workspace_id` string

## Response `200`

Publishing pause state

- object
  - `workspace` object
    - `id` string
    - `name` string, nullable
    - `paused` boolean
    - `paused_at` string, date-time, nullable
  - `brands` object[]: Paused brands the caller can see.
    - `id` string
    - `name` string, nullable
    - `paused` boolean
    - `paused_at` string, date-time
  - `viewer` object
    - `role` 'owner' | 'admin' | 'publisher' | 'editor' | 'viewer'
    - `can_pause_workspace` boolean
    - `can_pause_brand` boolean
    - `can_resume` boolean
    - `can_publish_missed` boolean

## Other responses

- `401`: Invalid or missing API key
- `403`: Request is authenticated but not allowed
- `429`: Too many requests

---

[API](https://skmtc.dev/poster/apis/posterly-api.md) · [All operations](https://skmtc.dev/poster/apis/posterly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/poster/apis/posterly-api/revisions/60be02a61f95?raw)