Fetch posts

GET

/{workspaceId}/posts

Fetches a list of all posts in the specified workspace

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.postly.ai/v2/683594f9d6bb51f6b3000000/posts?limit=10&offset=0' \
--header 'X-API-KEY;'

Response Example

200 - Example 1

{
    "code": "string",
    "message": "string",
    "data": [
        {
            "_id": "string",
            "text": "string",
            "media": [
                {
                    "url": "string",
                    "type": "string"
                }
            ],
            "timezone": "string",
            "one_off_schedule": {
                "one_off_date": "string",
                "time": "string",
                "timezone": "string"
            },
            "recurring_schedule": {
                "expression": "string",
                "start_date": "string",
                "end_date": "string",
                "time": "string",
                "timezone": "string",
                "week_days": [
                    {
                        "num": "string",
                        "value": true
                    }
                ],
                "day_of_month": 0,
                "rate_value": 0,
                "rate_unit": "string"
            },
            "created_at": "string",
            "updated_at": "string"
        }
    ]
}

Request

Authorization

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

Path Params

workspaceId

string

required

24-character hexadecimal identifier for the workspace

Example:

683594f9d6bb51f6b3000000

Query Params

limit

string

optional

Maximum number of posts to return

Example:

offset

string

optional

Number of posts to skip before starting to collect the result set

Example:

Responses

🟢200Success

application/json

Body

code

string

required

200

message

string

required

List of posts fetched successfully

data

array[object (Post) {8}]

required

_id

string

required

24-character hexadecimal post identifier

text

string

optional

Text content of the post

media

array [object {2}]

optional

Post media

timezone

string

optional

Timezone used for scheduling (IANA format)

one_off_schedule

object (OneOffSchedule)

optional

Optional one off schedule for one time posts

recurring_schedule

object (RecurringSchedule)

optional

Optional recurring schedule for recurring posts

created_at

string

required

Date string when post was created

updated_at

string

required

Date string when post was updated

🟠400BadRequestResponse

🟠401UnAuthorizedResponse

Modified at 2025-05-30 00:12:50

Fetch a post

Delete a post