Hanzo
OpenapiSocial

Returns the org's posts — content, channel, status, scheduled time, media and…

Returns the org's posts — content, channel, status, scheduled time, media and timestamps — most-recently-updated first.

GET /v1/social/posts

Addresshttps://api.hanzo.ai/v1/social/posts
MethodGET
Operationget_social_posts
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the org's posts — content, channel, status, scheduled time, media and timestamps — most-recently-updated first.

Request

2 fields.

FieldInTypeRequiredDescription
statusquerystringStatus keeps only posts in one state — draft, scheduled, published or failed. Omit it for every state.
limitquerystringLimit bounds the page, defaulting to 200 and capped at 1000.

Response

StatusBodyMeaning
200socialPostsok

200 body — 12 fields.

FieldInTypeAlwaysDescription
databodysocialPost[]Data is the posts, most-recently-updated first, bounded by the limit.
data[].accountIdbodystringAccountID / ExternalID / Error are server-managed publish results, set only by the publish path (never by a client update): the account a post was published…
data[].channelbodystringChannel is the network this post targets: x, facebook, instagram, linkedin, tiktok, youtube or threads.
data[].contentbodystringContent is the post's text, bounded at 8192 characters.
data[].createdAtbodyintegerCreatedAt is when the post was created, as a unix timestamp in seconds.
data[].errorbodystringError is why the last publish attempt failed, verbatim and bounded.
data[].externalIdbodystringExternalID is the id the network returned for the published post, which is what reconciles this row against the post on the network.
data[].idbodystringID is the post's identifier, minted on create and the id every later call addresses it by.
data[].mediabodystring[]Media is the post's attached media as a list of URLs (images today; the composer's URL field now, an S3 picker later, populate it).
data[].scheduleAtbodyintegerScheduleAt is when the post is due, as a unix timestamp in SECONDS. 0 means unscheduled.
data[].statusbodystringStatus is the post's lifecycle state: draft, scheduled, published or failed.
data[].updatedAtbodyintegerUpdatedAt is when the post row last changed, as a unix timestamp in seconds.

Failure carries the platform error shape — see Errors.

Examples

hanzo social posts list

Social API · All Hanzo APIs · Interactive reference

How is this guide?

On this page