---
title: "List posts"
method: GET
path: "/v1/posts"
---

# List posts

`GET /v1/posts`

## Request

- Base URL: `https://api.breakreach.com`
- URL: `https://api.breakreach.com/v1/posts`
- Auth: HTTP bearer

## Query parameters

- `workspace` string
- `status` 'draft' | 'scheduled' | 'published' | 'failed' | 'all'
- `limit` integer

## Response `200`

OK

- object
  - `posts` Post[], required
    - `id` string, required
    - `content` string, required
    - `status` 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed', required
    - `scheduledAt` string, date-time, required
    - `accountIds` string[], required
    - `media` string[], required
    - `metrics` object, nullable, required
      - `views` number
      - `likes` number
      - `comments` number
      - `shares` number
    - `error` string, nullable, required: Human-readable failure reason when status is failed

## Other responses

- `401`: Missing, invalid or expired API key
- `402`: No active Breakreach subscription or trial
- `403`: Not a member of the requested workspace
- `404`: Workspace not found

---

[API](https://skmtc.dev/breakreach/apis/breakreach-api.md) · [All operations](https://skmtc.dev/breakreach/apis/breakreach-api/llms.txt) · [OpenAPI document](https://skmtc.dev/breakreach/apis/breakreach-api/revisions/290d285f8d73?raw)