List posts

GET

/posts

const url = 'https://postflow.biz.id/api/v1/posts?status=scheduled';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://postflow.biz.id/api/v1/posts?status=scheduled' \
  --header 'Authorization: Bearer <token>'

By status (default scheduled, soonest first; other statuses newest first), or every post scheduled in [from, to) by time. Pages: when there are more, the response has an X-Next-Cursor header; send it as cursor.

MCP tool: list_posts.

Authorizations

apiKey
oauth

Parameters

Query Parameters

status

string

default: scheduled

Allowed values: scheduled published failed attention drafts

from

string format: date-time

With to. ISO time with an offset.

string format: date-time

accountId

string

Only posts that go to this account.

tagId

string

limit

integer

>= 1 <= 500

Default 50 (max 100) by status, 500 (max 500) by range.

cursor

string

The previous page’s X-Next-Cursor.

Responses

200

application/json

Array<object>

object

required

string

caption

required

string

scheduledAt

required

Any of:

string
null

string format: date-time

status

required

Derived from the targets.

string

Allowed values: draft scheduled paused publishing published partial failed needs_reschedule action_required

review

required

pending = waiting for the owner’s approval.

string

Allowed values: none pending

version

required

Send as expectedVersion when updating to avoid overwriting someone else’s change.

integer

media

required

Array<object>

object

required

Use in mediaIds.

string

kind

required

string

Allowed values: image video

mime

required

string

Allowed values: image/jpeg image/png image/webp image/gif video/mp4 video/quicktime video/webm

sizeBytes

required

integer

width

required

Any of:

integer
null

integer

height

required

Any of:

integer
null

integer

durationMs

required

Any of:

integer
null

integer

originalName

required

string

parentId

required

Any of:

string
null

Set on edited copies (e.g. a crop) of another file.

string

url

required

App path of the file. With the API, download it from /media/{id}/file.

string

thumbUrl

required

Any of:

string
null

string

createdAt

required

string format: date-time

targets

required

Array<object>

One account a post goes to.

object

required

Target id, for retrying one account.

string

socialAccountId

required

string

platform

required

string

Allowed values: facebook instagram tiktok threads bluesky youtube telegram

accountName

required

string

accountAvatarUrl

required

Any of:

string
null

string

contentType

required

string

Allowed values: fb_post fb_photo fb_video fb_reel ig_image ig_carousel ig_reel ig_story tt_video tt_photo th_text th_image th_video th_carousel tg_message tg_media bs_post bs_video yt_short yt_video

captionOverride

required

Any of:

string
null

string

mediaIds

required

Any of:

Array<string>
null

Array<string>

options

required

As sent in the request.

object

status

required

string

Allowed values: draft scheduled queued publishing published handed_off failed paused needs_reschedule

errorCode

required

Any of:

string
null

string

errorMessage

required

Any of:

string
null

Why publishing failed, in plain words.

string

permalink

required

Any of:

string
null

Link to the live post.

string

publishedAt

required

Any of:

string
null

string format: date-time

firstCommentStatus

required

Any of:

string
null

string

Allowed values: pending done failed

tags

required

Array<object>

object

required

string

name

required

string

color

required

Hex color

string

repeatDays

required

Any of:

integer
null

integer

shareToken

required

Any of:

string
null

Set while a public preview link exists.

string

clientApprovedAt

required

Any of:

string
null

string format: date-time

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

[
  {
    "status": "draft",
    "review": "none",
    "media": [
      {
        "kind": "image",
        "mime": "image/jpeg"
      }
    ],
    "targets": [
      {
        "platform": "facebook",
        "contentType": "fb_post",
        "status": "draft",
        "firstCommentStatus": "pending"
      }
    ]
  }
]

Headers

X-Next-Cursor

string

Cursor for the next page; absent on the last page.

400

Validation failed. details lists what to fix.

application/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}

401

Missing, invalid, expired or deleted key or token.

application/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}

429

More than 120 requests in a minute with this key.

application/json

object

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED FORBIDDEN NOT_FOUND VALIDATION CONFLICT SUBSCRIPTION_GRACE SUBSCRIPTION_EXPIRED PLAN_LIMIT RATE_LIMITED INTERNAL

message

required

A sentence you can show to a person.

string

details

Field errors ({ field: [messages] }), or preflight: per-account rule violations with an issue code.

Example

{
  "error": {
    "code": "UNAUTHENTICATED"
  }
}