Get posts

POST 
/social-media-posting/:locationId/posts/list

Get Posts

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location ID (also known as Sub-Account ID) for the business location.

application/json

application/json

Body

Bodyrequired

typestring
type must be one of the following values: recent, all, scheduled, draft, failed, in_review, published, in_progress, pending and deleted
Default value: all
accountsstring

List of account Ids separated by comma as a string

skipstring
Number of records to skip for pagination. Send as a numeric string — a JSON number is rejected.
Default value: 0
limitstring
Maximum number of records to return. Send as a numeric string — a JSON number is rejected.
Default value: 10
fromDatestring

From Date

toDatestring

To Date

includeUsersstring

Include User Data

postTypestring
Post Type must be one of the following values: post, story, reel, short
Matches the top-level type a post was created with (see the type field on Create Post), so only these three values can ever match a post.
Available optionspoststoryreel

Example (auto)

{
  "type": "all",
  "accounts": "660a83fc29deacac50033e2b_omaDY3RbWtTP511e808O_17841465964543589, 38bF83fc29deacac50033e2b_omaDY3RbWtr3P11e808O_17841465964543998",
  "skip": "0",
  "limit": "10",
  "fromDate": "2024-01-22T05:32:49.463Z",
  "toDate": "2024-03-20T05:32:49.463Z",
  "includeUsers": "true",
  "postType": "post"
}

application/json

Successful response

application/json

Schema

Schema

successbooleanrequired

Success or Failure

statusCodenumberrequired

Status Code

messagestringrequired

Message

resultsobject

Requested Results

Example (auto)

{
  "success": true,
  "statusCode": 201,
  "message": "Fetched Posts",
  "results": {
    "posts": [
      {
        "_id": "61bb16833b3f2791f9715be2",
        "locationId": "ve9EPM428h8vShlRW1KT",
        "status": "published",
        "insights": {
          "like": 0,
          "share": 0,
          "comment": 0
        }
      }
    ],
    "count": 6
  }
}