Skip to main content
GET
List posts

Authorizations

Authorization
string
header
required

An agent key (rpk_...) created in Settings → API & MCP, sent as Authorization: Bearer rpk_.... Bearer only: a cookie session can never drive this API. An OAuth 2.1 access token obtained from the same host works identically and lands on the same ceiling.

Headers

X-Workspace-Id
string

Which workspace to read. Omit it and you get the account’s home workspace, which on an agency account is often not where the live businesses are. A workspace this credential cannot read is refused with 403 rather than quietly answered from the default.

Query Parameters

q
string

JSON filter object, for example {"needs_response":true}.

sort_by
string

Field to sort on.

limit
integer

Maximum rows to return.

skip
integer

Rows to skip, for paging.

Response

Matching posts.

id
string

Unique id.

workspace_id
string
business_location_id
string
platform
enum<string>

Forward-compat enum. Only 'gbp' in PR-16; future PRs add facebook/instagram/etc.

Available options:
gbp
post_type
enum<string>

Update is PR-16 only; offer/event added in PR-18.

Available options:
update,
offer,
event
status
enum<string>

PR-18 added 'scheduled' for future-dated posts the worker tick fires at scheduled_at.

Available options:
draft,
scheduled,
publishing,
published,
failed,
cancelled
scheduled_at
string

UTC timestamp. Null for immediate-publish or already-published posts.

content
object
external_post_id
string

GBP returns 'accounts/X/locations/Y/localPosts/Z'. Stored verbatim.

published_at
string
error_message
string
error_count
integer
ai_generated
boolean
ai_chat_session_id
string
is_active
boolean