Skip to content
OpenPostDocs
OpenPostDocs
Publications

List publications

GET/publications

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

workspace_id*string

Workspace ID

status?string

Optional status filter

activity_bucket?string

Optional Publication activity bucket filter

Value in

  • "scheduled"
  • "published"
  • "failed"
  • "draft"
content_profile?string

Optional content profile filter

platform?string

Optional destination platform filter

search?string

Case-insensitive title or source-text search

cursor?string

Opaque cursor for stable newest-first pagination

created_from?string

Include publications created at or after this RFC3339 timestamp

created_before?string

Include publications created before this RFC3339 timestamp

calendar_from?string

Include calendar occurrences at or after this RFC3339 timestamp

calendar_before?string

Include calendar occurrences before this RFC3339 timestamp

limit?integer

Limit, default 50

Formatint64
offset?integer

Offset

Formatint64

Response Body

application/json

application/problem+json

curl -X GET "https://example.com/publications?workspace_id=string"
[  {    "$schema": "https://example.com/api/v1/schemas/PublicationResponse.json",    "actual_run_at": "string",    "audience": "string",    "content_profile": "string",    "created_at": "string",    "created_by": "string",    "creation_preset": "string",    "failure_dismissed_at": "string",    "goal": "string",    "id": "string",    "intent": "string",    "media": [      {        "alt_text": "string",        "analysis_error": "string",        "analysis_status": "string",        "aspect_ratio": "string",        "display_order": 0,        "dominant_type": "string",        "duration_ms": 0,        "frame_rate": 0.1,        "height": 0,        "id": "string",        "mime_type": "string",        "original_filename": "string",        "poster_thumbnail_url": "string",        "public_url_checked_at": "string",        "public_url_error": "string",        "public_url_ready": true,        "public_url_status": 0,        "role": "string",        "settings": {          "property1": null,          "property2": null        },        "size": 0,        "thumbnail_timestamp_ms": 0,        "url": "string",        "width": 0      }    ],    "metadata": {      "property1": null,      "property2": null    },    "random_delay_inherited": true,    "random_delay_minutes": 0,    "renditions": [      {        "body": "string",        "delivery": {          "current_attempt_created_at": "string",          "current_attempt_id": "string",          "current_attempt_number": 0,          "error_code": "string",          "error_http_status": 0,          "error_kind": "string",          "external_id": "string",          "external_url": "string",          "last_reconciled_at": "string",          "next_reconciliation_at": "string",          "recovery_action": "none",          "state": "string",          "target_key": "string",          "terminal_reason": "string"        },        "description": "string",        "error_action": "string",        "error_code": "string",        "error_http_status": 0,        "error_kind": "string",        "error_message": "string",        "error_retry_at": "string",        "error_retryable": true,        "external_id": "string",        "external_url": "string",        "format_locked": true,        "id": "string",        "media": [          {            "alt_text": "string",            "analysis_error": "string",            "analysis_status": "string",            "aspect_ratio": "string",            "display_order": 0,            "dominant_type": "string",            "duration_ms": 0,            "frame_rate": 0.1,            "height": 0,            "id": "string",            "mime_type": "string",            "original_filename": "string",            "poster_thumbnail_url": "string",            "public_url_checked_at": "string",            "public_url_error": "string",            "public_url_ready": true,            "public_url_status": 0,            "role": "string",            "settings": {              "property1": null,              "property2": null            },            "size": 0,            "thumbnail_timestamp_ms": 0,            "url": "string",            "width": 0          }        ],        "output_profile": "string",        "platform": "string",        "profile": "string",        "publication_id": "string",        "schedule_override": "string",        "segments": [          {            "body": "string",            "body_override": "string",            "description": "string",            "description_override": "string",            "error_action": "string",            "error_code": "string",            "error_http_status": 0,            "error_kind": "string",            "error_message": "string",            "error_retry_at": "string",            "error_retryable": true,            "external_id": "string",            "external_url": "string",            "id": "string",            "media": [              {                "alt_text": "string",                "analysis_error": "string",                "analysis_status": "string",                "aspect_ratio": "string",                "display_order": 0,                "dominant_type": "string",                "duration_ms": 0,                "frame_rate": 0.1,                "height": 0,                "id": "string",                "mime_type": "string",                "original_filename": "string",                "poster_thumbnail_url": "string",                "public_url_checked_at": "string",                "public_url_error": "string",                "public_url_ready": true,                "public_url_status": 0,                "role": "string",                "settings": {                  "property1": null,                  "property2": null                },                "size": 0,                "thumbnail_timestamp_ms": 0,                "url": "string",                "width": 0              }            ],            "media_inherited": true,            "position": 0,            "publication_segment_id": "string",            "settings": {              "property1": null,              "property2": null            },            "status": "string",            "title": "string",            "title_override": "string",            "url": "string",            "url_override": "string"          }        ],        "settings": {          "property1": null,          "property2": null        },        "social_account_id": "string",        "status": "string",        "target_key": "string",        "title": "string"      }    ],    "repost_override": {      "mode": "inherit",      "rule": {        "delay_seconds": 0,        "evaluation_window_seconds": 900,        "min_comments": 0,        "min_likes": 0,        "min_reposts": 0,        "min_views": 0,        "plateau_checks": 2,        "require_plateau": true,        "stages": [          {            "delay_seconds": 0,            "unrepost_previous": true          }        ],        "threshold_mode": "all"      },      "target_account_ids": [        "string"      ]    },    "revision": 0,    "scheduled_at": "string",    "segments": [      {        "body": "string",        "description": "string",        "id": "string",        "media": [          {            "alt_text": "string",            "analysis_error": "string",            "analysis_status": "string",            "aspect_ratio": "string",            "display_order": 0,            "dominant_type": "string",            "duration_ms": 0,            "frame_rate": 0.1,            "height": 0,            "id": "string",            "mime_type": "string",            "original_filename": "string",            "poster_thumbnail_url": "string",            "public_url_checked_at": "string",            "public_url_error": "string",            "public_url_ready": true,            "public_url_status": 0,            "role": "string",            "settings": {              "property1": null,              "property2": null            },            "size": 0,            "thumbnail_timestamp_ms": 0,            "url": "string",            "width": 0          }        ],        "position": 0,        "settings": {          "property1": null,          "property2": null        },        "title": "string",        "url": "string"      }    ],    "social_set_id": "string",    "source_text": "string",    "source_url": "string",    "status": "string",    "title": "string",    "updated_at": "string",    "workspace_id": "string"  }]