Skip to content
Pinlyx Docs
Open app

List social posts

GET
/v1/social/posts

Cursor-paginated posts, newest id first. from/to filter on the scheduled instant. Requires scope posts:read.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
status
string
Allowed values: pending processing published failed cancelled partiallypublished
platform
string
from
string format: date-time
to
string format: date-time
limit
integer
default: 25 >= 1 <= 100
after
integer

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Paginated post list.

object
items
Array<object>

One scheduled or published post on a single account.

object
id
integer
accountId

Connected account id

integer
nullable
externalAccountId
string
platform
string
Example
linkedin
content
string
mediaUrls
Array<string>
nullable
scheduledAt

Publish instant

string format: date-time
status
string
Allowed values: pending processing published failed cancelled partiallypublished
externalPostId

The network’s post id

string
nullable
publishedUrl
string
nullable
errorMessage
string
nullable
retryCount
integer
createdAt
string format: date-time
updatedAt
string format: date-time
nullable
publishedAt
string format: date-time
nullable
nextCursor
integer
nullable
hasMore
boolean

400

Section titled “400 ”

The request body or parameters failed validation.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "bad_request",
  "message": "at least one of name, username, phone is required"
}

401

Section titled “401 ”

Missing or invalid bearer token.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "unauthorized",
  "message": "Invalid bearer principal"
}

402

Section titled “402 ”

The workspace’s plan does not include this module. The social inbox needs channel_social_inbox and the post scheduler needs marketing_social_scheduler; details.FeatureKey names the one that is missing. Upgrading unlocks it, there is nothing to retry.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "payment_required",
  "message": "your plan does not include this feature; upgrade to unlock it",
  "details": {
    "FeatureKey": "marketing_social_scheduler",
    "UpgradeRequired": true
  }
}

403

Section titled “403 ”

The API key does not have the required scope for this operation.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "forbidden",
  "message": "scope contacts:write is required"
}

429

Section titled “429 ”

Per-key rate limit exceeded. Retry after the time indicated by X-RateLimit-Reset.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "rate_limited",
  "message": "rate limit exceeded"
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests allowed per minute for this key.

X-RateLimit-Remaining
integer

Requests remaining in the current window.

X-RateLimit-Reset
integer

Unix timestamp (seconds) when the rate limit window resets.